L_Doc2GetEngineFormatFriendlyName

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2GetEngineFormatFriendlyName(hDoc, Format, pszFormatName, pnLength)

Gets the provided document format ID friendly name.

Parameters

L_HDOC2 hDoc

Handle to the OCR document. This handle is obtained by calling the L_Doc2StartUp function.

DOC2_FORMATTYPE Format

The document format ID to retrieve it's friendly name.

L_TCHAR * pszFormatName

Pointer to a character string to be updated with the document format friendly name.

L_INT * pnLength

Pointer to variable to be updated with the length of the document format friendly name character string.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

To use the L_Doc2GetEngineFormatFriendlyName function:

  1. Call this function passing pszFormatName as NULL to obtain the document format friendly name length in the pnLength parameter.
  2. Allocate a buffer of size (*pnLength).
  3. Call this function with passing the allocated buffer to the pszFormatName parameter to obtain the document format friendly name.

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

Help Version 21.0.2021.1.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS OCR Module - OmniPage Engine C API Help