IG_REC_vertical_dict

Enables a vertical dictionary for use by the checking module.

Declaration:

	Copy Code
AT_ERRCOUNT IG_REC_vertical_dict_enable( const AT_CHAR* description );

Arguments:

Name	Type	Description
description	const AT_CHAR*	Description of the dictionary to enable, obtained from IG_REC_vertical_dict_available_desc_get.

Return Value:

Returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

This function does not process image pixels.

Example:

	Copy Code
AT_ERRCOUNT ErrCount = 0; AT_INT iVDCount = 0; AT_INT iVDIndex = 0; AT_INT iDescLen = 0; AT_CHAR* lpBuffer = 0; AT_BOOL bEnabled = FALSE; ErrCount += IG_REC_vertical_dict_available_count_get(&iVDCount); while(iVDIndex < iVDCount) { ErrCount += IG_REC_vertical_dict_available_desc_len_get(iVDIndex, &iDescLen); lpBuffer = (AT_CHAR) malloc(iDescLen sizeof(AT_CHAR)); if(lpBuffer) { ErrCount += IG_REC_vertical_dict_available_desc_get(iVDIndex, lpBuffer, iDescLen); ErrCount += IG_REC_vertical_dict_enable(lpBuffer); //... free(lpBuffer); } iVDIndex++; }

Copy Code

AT_ERRCOUNT ErrCount = 0;
AT_INT iVDCount = 0;
AT_INT iVDIndex = 0;
AT_INT iDescLen = 0;
AT_CHAR* lpBuffer = 0;
AT_BOOL bEnabled = FALSE;

ErrCount += IG_REC_vertical_dict_available_count_get(&iVDCount);
while(iVDIndex < iVDCount)
{
    ErrCount += IG_REC_vertical_dict_available_desc_len_get(iVDIndex, &iDescLen);
    lpBuffer = (AT_CHAR*) malloc(iDescLen * sizeof(AT_CHAR));
    if(lpBuffer)
    {
        ErrCount += IG_REC_vertical_dict_available_desc_get(iVDIndex, lpBuffer, iDescLen);
        ErrCount += IG_REC_vertical_dict_enable(lpBuffer);

        //...

        free(lpBuffer);
    }
    iVDIndex++;
}

Remarks:

Specifying a Vertical dictionary is a page-level setting. Once it is specified, it is applied to all zones on the page, except in zones with their IG_REC_ZCF_VERTDICT_PROHIBIT flag set. This is useful for excluding zones from the Vertical dictionary checking.