Returns the flag indicating whether or not to insert page breaks into the output document.
Declaration:
 Copy Code |
|
|---|---|
AT_ERRCOUNT ACCUAPI IG_REC_converter_pagebreaks_get( LPCSTR lpszFormatName, enumIGRecPageBreaks* lpPageBreaks ); |
|
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. |
| lpPageBreaks | enumIGRecPageBreaks* | Buffer to retrieve Page Breaks value. |
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; enumIGRecPageBreaks ePagebreaks = IG_REC_PB_AUTO; 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); if(bCPBsIsApplicable) ErrCount += IG_REC_converter_pagebreaks_get(lpszFormatName, &ePagebreaks); |
|
Remarks:
See IG_REC_converter_pagebreaks_set for formats that support this flag.
The page breaks 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.