Sets the string that separates the pages in the output document.
Declaration:
 Copy Code |
|
|---|---|
AT_ERRCOUNT ACCUAPI IG_REC_converter_pagebreak_set( LPCSTR lpszFormatName, LPAT_WCHAR lpwszPageBreak ); |
|
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 | String to be set as page break. |
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 = L"This is a pagebreak string"; ErrCount += IG_REC_output_format_set(lpszFormatName); ErrCount += IG_REC_converter_pagebreak_is_applicable(lpszFormatName, &bCPBIsApplicable); if(bCPBIsApplicable) ErrCount += IG_REC_converter_pagebreak_set(lpszFormatName, lpwszPagebreak); |
|
Remarks:
The function affects the following output formats:
- Converters.Text.Csv
- Converters.Text.UCsv
- Converters.Text.Text
- Converters.Text.UText
- Converters.Text.FormattedTxt
- Converters.Text.UFormattedTxt
- Converters.Text.TextWithLinebreaks
- Converters.Text.UTextWithLinebreaks
The page break 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.