[This is preliminary documentation and subject to change.]

Opens the file to process.

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

Parameters

p_sPath

Full path of the input file.

p_sLanguage

The code of the language to process. 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 file is opened successfully, false if an error occurs.

Remarks

Use this method to open the input file to process. You must call CloseInput after the file has been processed. To process a string, use the OpenInputString method.

Example

See ReadItem for an example.

See Also

IFilter Interface | Okapi.Library.Filter Namespace | CloseInput | OpenInputString | ResetInput | ReadItem

---