IG_REC_converter_linebreak

Returns the string that separates the lines.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_converter_linebreak_get( LPCSTR lpszFormatName, LPAT_WCHAR lpwszLineBreak, 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.
lpwszLineBreak	LPAT_WCHAR	Buffer to retrieve the line break string.
nBufferLength	AT_INT	Length of lpszLineBreak 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.

Remarks:

The line break string 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.

Example:

	Copy Code
AT_ERRCOUNT ErrCount = 0; AT_INT iLength = 0; AT_BOOL bCLBIsApplicable = FALSE; LPCSTR lpszFormatName = "Converters.Text.Csv"; LPAT_WCHAR lpwszLinebreak = 0; ErrCount += IG_REC_output_format_set(lpszFormatName); ErrCount += IG_REC_converter_linebreak_is_applicable(lpszFormatName, &bCLBIsApplicable); if(bCLBIsApplicable) { ErrCount += IG_REC_converter_linebreak_length_get(lpszFormatName, &iLength); lpwszLinebreak = (LPAT_WCHAR) malloc((iLength + 1) * sizeof(AT_WCHAR)); if(lpwszLinebreak != NULL) { ErrCount += IG_REC_converter_linebreak_get(lpszFormatName, lpwszLinebreak, iLength); free(lpwszLinebreak); } }

Copy Code

AT_ERRCOUNT ErrCount = 0;
AT_INT iLength = 0;
AT_BOOL bCLBIsApplicable = FALSE;
LPCSTR lpszFormatName = "Converters.Text.Csv";
LPAT_WCHAR lpwszLinebreak = 0;

ErrCount += IG_REC_output_format_set(lpszFormatName);
ErrCount += IG_REC_converter_linebreak_is_applicable(lpszFormatName,
    &bCLBIsApplicable);
if(bCLBIsApplicable)
{
    ErrCount += IG_REC_converter_linebreak_length_get(lpszFormatName, &iLength);
    lpwszLinebreak = (LPAT_WCHAR) malloc((iLength + 1) * sizeof(AT_WCHAR));
    if(lpwszLinebreak != NULL)
    {
        ErrCount += IG_REC_converter_linebreak_get(lpszFormatName,
            lpwszLinebreak, iLength);
        free(lpwszLinebreak);
    }
}