IG_REC_converter_beginparagraph

Returns the string to be inserted into the output text signifying the beginning of a paragraph.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_converter_beginparagraph_get( LPCSTR lpszFormatName, LPAT_WCHAR lpwszBeginParagraph, 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.
lpwszBeginParagraph	LPAT_WCHAR	Buffer to retrieve the begin of a paragraph string.
nBufferLength	AT_INT	Length of lpwszBeginParagraph buffer. Use IG_REC_converter_beginparagraph_length_get to get necessary length.

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 bCBPIsApplicable = FALSE; LPCSTR lpszFormatName = "Converters.Text.Csv"; LPAT_WCHAR lpwszBeginParagraph = 0; ErrCount += IG_REC_output_format_set(lpszFormatName); ErrCount += IG_REC_converter_beginparagraph_is_applicable(lpszFormatName, &bCBPIsApplicable); if(bCBPIsApplicable) { ErrCount += IG_REC_converter_beginparagraph_length_get(lpszFormatName, &iLength); lpwszBeginParagraph = (LPAT_WCHAR) malloc((iLength + 1) * sizeof(AT_WCHAR)); if(lpwszBeginParagraph != NULL) { ErrCount += IG_REC_converter_beginparagraph_get(lpszFormatName, lpwszBeginParagraph, iLength); free(lpwszBeginParagraph); } }

Copy Code

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

ErrCount += IG_REC_output_format_set(lpszFormatName);
ErrCount += IG_REC_converter_beginparagraph_is_applicable(lpszFormatName,
    &bCBPIsApplicable);
if(bCBPIsApplicable)
{
    ErrCount += IG_REC_converter_beginparagraph_length_get(lpszFormatName, &iLength);
    lpwszBeginParagraph = (LPAT_WCHAR) malloc((iLength + 1) * sizeof(AT_WCHAR));
    if(lpwszBeginParagraph != NULL)
    {
        ErrCount += IG_REC_converter_beginparagraph_get(lpszFormatName,
            lpwszBeginParagraph, iLength);
        free(lpwszBeginParagraph);
    }
}

Remarks:

Begin paragraph 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 non-zero value and appends IGE_REC_CONVERTER_NOT_INITIALIZED error code to the error stack.