[This is preliminary documentation and subject to change.]

Creates the output file. Call SetOutputOptions before calling this method.

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

Parameters

p_sPath

Full path of the file to create.

Return Value

True if the file was created successfully, false otherwise.

Remarks

Use this method to open an output file. The path of the output file can be the same as the input file.

If you want to use an encoding or a language in the output that is different from the input encoding or language, you must call SetOutputOptions before calling this method.

If you use a layered output, you must call UseOutputLayer before calling this method (and after calling SetOutputOptions).

Note that some filters may generate the actual final output only when CloseOutput is called, at the end of the process.

Example

See WriteItem for an example.

See Also

IFilter Interface | Okapi.Library.Filter Namespace | CloseOutput | UseOutputLayer | SetOutputOptions

---