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

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

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_converter_pagemargins_usage_set(
   LPCSTR lpszFormatName,
   AT_BOOL bUsePageMargins
);

Arguments:

Name Type Description
lpszFormatName LPCSTR Symbolic name of the output format like Converters.Text.Cvs.
bUsePageMargins AT_BOOL Boolean value to be set. TRUE means that the default page margins should be used when saving recognition results. FALSE retains margins.

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_set(lpszFormatName, bUsePageMargins);

Remarks:

The function affects the following output formats:

Margins usage flag can't be set 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.