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

Returns the string that separates the pages.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_converter_pagebreak_get(
   LPCSTR lpszFormatName,
   LPAT_WCHAR lpwszPageBreak,
   AT_INT nBufferLength
);

Arguments:

Name Type Description
lpszFormatName LPCSTR Symbolic name of the output format like Converters.Text.Cvs. See IG_REC_output_format_set for more info about format names.
lpwszPageBreak LPAT_WCHAR Buffer to retrieve the page break.
nBufferLength AT_INT Length of lpszPageBreak buffer.

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_INT iLength = 0;
AT_BOOL bCPBIsApplicable = FALSE;
LPCSTR lpszFormatName = "Converters.Text.Csv";
LPAT_WCHAR lpwszPagebreak = 0;

ErrCount += IG_REC_output_format_set(lpszFormatName);
ErrCount += IG_REC_converter_pagebreak_is_applicable(lpszFormatName, &bCPBIsApplicable);
if(bCPBIsApplicable)
{
    ErrCount += IG_REC_converter_pagebreak_length_get(lpszFormatName, &iLength);
    lpwszPagebreak = (LPAT_WCHAR) malloc((iLength + 1) * sizeof(AT_WCHAR));
    if(lpwszPagebreak != NULL)
    {
        ErrCount += IG_REC_converter_pagebreak_get(lpszFormatName, lpwszPagebreak, iLength);
        free(lpwszPagebreak);
    }
}

Remarks:

The page break length 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.