#include "ltdoc2.h"
L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2GetEngineFormatFriendlyName(hDoc, Format, pszFormatName, pnLength)
Gets the provided document format ID friendly name.
Handle to the OCR document. This handle is obtained by calling the L_Doc2StartUp function.
The document format ID to retrieve it's friendly name.
Pointer to a character string to be updated with the document format friendly name.
Pointer to variable to be updated with the length of the document format friendly name character string.
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
To use the L_Doc2GetEngineFormatFriendlyName function:
Before calling this function, you must declare a variable as a pointer to a character string. Then, pass the variable in the pszFormatName parameter. This function will update the variable with the document format friendly name character string.
✎ NOTE
The pnLength parameter should always be passed to represent the allocated format name parameter length; otherwise the function will return ERROR_INV_PARAMETER.
Required DLLs and Libraries