ImageGear for C and C++ on Windows v19.1 - Updated
IG_REC_vertical_dict_available_desc_get
API Reference Guide > Recognition Component API Reference > Recognition Component Functions Reference > Vertical Dictionary Functions > IG_REC_vertical_dict_available_desc_get

Gets the description of a vertical dictionary for use with IG_REC_vertical_dict_is_enabled, IG_REC_vertical_dict_enable, and IG_REC_vertical_dict_disable.

Declaration:

 
Copy Code
AT_ERRCOUNT IG_REC_vertical_dict_available_desc_get(
   AT_INT index,
   AT_CHAR* lpBuffer,
   AT_INT bufLen
);

Arguments:

Name Type Description
index AT_INT Index of the vertical dictionary description to retrieve.
lpBuffer AT_CHAR* Buffer to hold the description.
bufLen AT_INT Length of the buffer for the description. If this is insufficient to hold the description, an error will occur.

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;

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);
        //...
        free(lpBuffer);
    }
    iVDIndex++;
}