Sets the flag indicating whether or not to insert page breaks into the output document.
Declaration:
 Copy Code |
|
|---|---|
AT_ERRCOUNT ACCUAPI IG_REC_converter_pagebreaks_set( LPCSTR lpszFormatName, enumIGRecPageBreaks nPageBreaks ); |
|
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. |
| nPageBreaks | enumIGRecPageBreaks | PageBreaks value to be set. |
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 bCPBsIsApplicable = FALSE; enumIGRecPageBreaks ePagebreaks = IG_REC_PB_AUTO; 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_set(lpszFormatName, ePagebreaks); |
|
Remarks:
The function affects the following output formats:
- Converters.Text.Csv
- Converters.Text.UCsv
- Converters.Text.DocX
- Converters.Text.eBook
Formatted output in eBook format is not supported by the 64-bit SDK. - Converters.Text.Excel2000
- Converters.Text.Excel97
- Converters.Text.Html32
- Converters.Text.Html40
- Converters.Text.InfoPath
- Converters.Text.Kindle
- Converters.Text.MicrosoftReader
- Converters.Text.PowerPoint97
- Converters.Text.PptX
- Converters.Text.Publisher98
- Converters.Text.Text
- Converters.Text.RTF2000
- Converters.Text.RTF2000SWord
- Converters.Text.RTF6
- Converters.Text.RTF97
- Converters.Text.Word2000
- Converters.Text.Word97
- Converters.Text.WordML
- Converters.Text.WordPad
- Converters.Text.WordPerfect10
- Converters.Text.XlsX
- Converters.Text.XML
- Converters.Text.UText
- Converters.Text.FormattedTxt
- Converters.Text.UFormattedTxt
- Converters.Text.TextWithLinebreaks
- Converters.Text.UTextWithLinebreaks
The page breaks 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.