[This is preliminary documentation and subject to change.]

Escape a string for RTF output.

[Visual Basic]
Shared Public Function EscapeToRTF( _ 
   ByVal p_sText As String, _ 
   ByVal p_bConvertLineBreaks As Boolean, _ 
   ByVal p_nLineBreakStyle As Integer, _ 
   ByVal p_Enc As Encoding _ 
) As String
[C#]
public static string EscapeToRTF(
   string p_sText,
   bool p_bConvertLineBreaks,
   int p_nLineBreakStyle,
   Encoding p_Enc
);
[C++]
public: static String* EscapeToRTF(
   String* p_sText,
   bool p_bConvertLineBreaks,
   int p_nLineBreakStyle,
   Encoding* p_Enc
);
[JScript]
public static function EscapeToRTF(
   String p_sText,
   bool p_bConvertLineBreaks,
   int p_nLineBreakStyle,
   Encoding p_Enc
): String;

Parameters

p_sText

The text to convert.

p_bConvertLineBreaks

Indicator if line-breaks need to be converted or not.

p_nLineBreakStyle

Type of line-break conversion. 0=do nothing special, 1=close then re-open as external, 2=close then re-open as internal.

p_Enc

Encoding to use for raw characters.

Return Value

The specified text converted in RTF.

See Also

Routines Class | Okapi.Library.Base Namespace

---