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

Returns a Boolean value indicating whether or not PageBreaks setting is applicable for the given format.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_converter_pagebreaks_is_applicable(
   LPCSTR lpszFormatName,
   LPAT_BOOL lpIsApplicable
);

Arguments:

Name Type Description
lpszFormatName LPCSTR Symbolic name of the output format like Converters.Text.Cvs.
lpIsApplicable AT_BOOL Buffer to retrieve a result of checking. TRUE means that the format supports PageBreaks setting.

Return Value:

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

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

See IG_REC_converter_pagebreaks_set for formats that support this setting.

Example:

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

ErrCount += IG_REC_output_format_set(lpszFormatName);
ErrCount += IG_REC_converter_pagebreaks_is_applicable(lpszFormatName,
    &bCPBsIsApplicable);

Remarks:

See IG_REC_converter_pagebreaks_set for formats that support this setting.