Okapi .NET Library

IFilter.SetOutputOptions Method 

 [This is preliminary documentation and subject to change.]

Sets the options for the output. Call this method before calling OpenOutputFile.

[Visual Basic]
Function SetOutputOptions( _ 
   ByVal p_sLanguage As String, _ 
   ByVal p_sEncoding As String _ 
) As Boolean
[C#]
bool SetOutputOptions(
   string p_sLanguage,
   string p_sEncoding
);
[C++]
bool SetOutputOptions(
   String* p_sLanguage,
   String* p_sEncoding
);
[JScript]
function SetOutputOptions(
   String p_sLanguage,
   String p_sEncoding
): bool;

Parameters

p_sLanguage
The code of the language for the output. The code must be an RFC3066 tag.
p_sEncoding
The name of the encoding of the file. The name must be an IANA charset name. This parameter is used only if the filter cannot detect automatically the encoding of the file.

Return Value

True if the options are set successfully, false if an error occurs.

Remarks

Use this method to specify the language and encoding of the output.

If they are both the same as for the input, you do not have to call this method.

If you call this method, you must call it before calling OpenOutputFile or OpenOutputString.

See Also

IFilter Interface | Okapi.Library.Filter Namespace | OpenInputFile | OpenInputString | OpenOutputFile | OpenOutputString