Nicomsoft OCR: Developer's Guide


Cfg_SaveOptionsToString


Syntax

C++:int Cfg_SaveOptionsToString(HCFG CfgObj, UNICODECHAR* XMLString, int MaxLen)
C#:int Cfg_SaveOptionsToString(int CfgObj, out string XMLString)
Visual Basic:Function Cfg_SaveOptionsToString(ByVal CfgObj As Integer, ByRef XMLString As String) As Integer
Java:int Cfg_SaveOptionsToString(HCFG CfgObj, StringBuffer XMLString)
Delphi:function Cfg_SaveOptionsToString(CfgObj:HCFG; XMLString:PWCHAR; MaxLen:integer):integer


Description

Saves the OCR configuration to a string.


Parameters

CfgObj [IN] – the Config object.
XMLString [OUT] – the buffer that will get the Unicode, null-terminated string that contains the OCR configuration data in the XML format.
MaxLen [IN] – the buffer size in Unicode characters, including the null termination character. If 0, then the function will not copy anything to the buffer, but will only return the buffer size (in Unicode characters, without the null termination character) needed to store the text.


Return value

Zero if success, otherwise an error code.


Remarks

None.


Example

None.