[This is preliminary documentation and subject to change.]

Sets the layer information for the output.

[Visual Basic]
Function UseOutputLayer( _ 
   ByVal p_nLayer As Integer, _ 
   ByVal p_sStartDocument As String, _ 
   ByVal p_sEndDocument As String, _ 
   ByVal p_sStartCode As String, _ 
   ByVal p_sEndCode As String, _ 
   ByVal p_sStartInline As String, _ 
   ByVal p_sEndInline As String, _ 
   ByVal p_sStartText As String, _ 
   ByVal p_sEndText As String _ 
) As Boolean
[C#]
bool UseOutputLayer(
   int p_nLayer,
   string p_sStartDocument,
   string p_sEndDocument,
   string p_sStartCode,
   string p_sEndCode,
   string p_sStartInline,
   string p_sEndInline,
   string p_sStartText,
   string p_sEndText
);
[C++]
bool UseOutputLayer(
   int p_nLayer,
   String* p_sStartDocument,
   String* p_sEndDocument,
   String* p_sStartCode,
   String* p_sEndCode,
   String* p_sStartInline,
   String* p_sEndInline,
   String* p_sStartText,
   String* p_sEndText
);
[JScript]
function UseOutputLayer(
   int p_nLayer,
   String p_sStartDocument,
   String p_sEndDocument,
   String p_sStartCode,
   String p_sEndCode,
   String p_sStartInline,
   String p_sEndInline,
   String p_sStartText,
   String p_sEndText
): bool;

Parameters

p_nLayer

Type of layer to use in the output. The value must be one of the FilterOutputLayer values.

p_sStartDocument

Codes to place a the start of the layered output.

p_sEndDocument

Codes to place at the end of the layered output.

p_sStartCode

Codes to place before runs of external codes.

p_sEndCode

Codes to place after runs of external codes.

p_sStartInline

Codes to lace before runs of internal codes.

p_sEndInline

Codes to place after runs of internal codes.

p_sStartText

[Reserved for future use]

p_sEndText

[Reserved for future use]

Return Value

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

Remarks

This method should be called before you call OpenOutputFile or OpenOutputString. You do not need to call this method if the output has no extra layer.

See Also

IFilter Interface | Okapi.Library.Filter Namespace

---