ImageGear for C and C++ on Windows v19.5 - Updated
IG_REC_converter_pagemargins_usage_get
API Reference Guide > Recognition Component API Reference > Recognition Component Functions Reference > Converter Settings Functions > IG_REC_converter_pagemargins_usage_get

Returns a Boolean value indicating whether page margins are retained or default values are used.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_converter_pagemargins_usage_get(
   LPCSTR lpszFormatName,
   LPAT_BOOL lpUsePageMargins
);

Arguments:

Name Type Description
lpszFormatName LPCSTR Symbolic name of the output format like Converters.Text.Cvs.
lpUsePageMargins LPAT_BOOL Buffer to retrieve the Boolean value. TRUE means that the default page margins should be used when saving recognition results.

Return Value:

The number of ImageGear errors that occurred during the function call.

Supported Raster Image Formats:

This function does not process image pixels.

Example:

 
Copy Code
AT_ERRCOUNT ErrCount = 0;
AT_BOOL bUsePageMargins = FALSE;
LPCSTR lpszFormatName = "Converters.Text.Csv";

ErrCount += IG_REC_output_format_set(lpszFormatName);
ErrCount += IG_REC_converter_pagemargins_usage_get(lpszFormatName,
    &bUsePageMargins);

Remarks:

See IG_REC_converter_pagemargins_usage_set for formats that support this setting.

Margins usage flag can't be retrieved if the corresponding output format has not been selected with IG_REC_output_format_set at least once. In this case the function returns a non-zero value and appends IGE_REC_CONVERTER_NOT_INITIALIZED error code to the error stack.