ImageGear for C and C++ on Windows v19.2 - Updated
IG_REC_output_format_first_get
API Reference Guide > Recognition Component API Reference > Recognition Component Functions Reference > Output Functions > IG_REC_output_format_first_get

Starts the enumeration of the document output formats and returns the name of the first one.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_output_format_first_get(
   LPSTR lpszFormatName,
   AT_INT nBuflen
);

Arguments:

Name Type Description
lpszFormatName LPSTR Buffer to receive the output format name.
nBuflen AT_INT Length of the buffer.

Return Value:

Returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

This function does not process image pixels.

Example:

 
Copy Code
AT_ERRCOUNT ErrCount = 0;
char *lpszFormatName = malloc(AM_MAX_OUTPUT_FORMAT_NAME_LEN);
ErrCount = IG_REC_output_format_first_get(lpszFormatName, AM_MAX_OUTPUT_FORMAT_NAME_LEN);

//...

free(lpszFormatName);

Remarks:

Maximal length of the format name is AM_MAX_OUTPUT_FORMAT_NAME_LEN.