ImageGear for C and C++ on Windows v19.1 - Updated
IG_REC_converter_beginparagraph_set
API Reference Guide > Recognition Component API Reference > Recognition Component Functions Reference > Converter Settings Functions > IG_REC_converter_beginparagraph_set

Sets 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_set(
   LPCSTR lpszFormatName,
   LPAT_WCHAR lpwszBeginParagraph
);

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 String to be set as the beginning of a paragraph.

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 = L"This is the beginning of a paragraph";

ErrCount += IG_REC_output_format_set(lpszFormatName);
ErrCount += IG_REC_converter_beginparagraph_is_applicable(lpszFormatName,
    &bCBPIsApplicable);
if(bCBPIsApplicable)
    ErrCount += IG_REC_converter_beginparagraph_set(lpszFormatName,
        lpwszBeginParagraph);

Remarks:

The function affects the following output formats:

See IG_REC_converter_beginparagraph_is_applicable.

The begin paragraph string 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.