ImageGear Professional DLL v17.1 for Windows Accusoft
LPAFT_IG_METAD_ITEM_GET_CB
Send Feedback  
ImageGear Professional DLL v17.1 for Windows > API Reference Guide > Core Component API Reference > Core Component Callback Functions Reference > LPAFT_IG_METAD_ITEM_GET_CB

Glossary Item Box

This callback function is used to get information about metadata items received during READ filter operation.

Declaration:

  Copy Code
typedef VOID (LPACCUAPI LPAFT_IG_METAD_ITEM_GET_CB)(
        LPVOID lpPrivate, 
        AT_MODE FormatID, 
        LPCHAR ItemName,  
        DWORD ItemID, 
        AT_MODE ItemType, 
        LPVOID ItemValue, 
        AT_MODE ValueType,
        DWORD ValueLength,
        AT_BOOL ReadOnlyValue 
);

Arguments:

lpPrivate Private callback data.
FormatID The ID of format filter that send or get the item (IG_FORMAT_... constant).
ItemName Name of item.
ItemID Numerical ID of item.
ItemType Specifies the type of item and reflect the status of given record. Possible values are:
  • IG_METAD_VALUE_ITEM - this value specifies that current item is value of simplest type and field Value contains actual value of item and ValueType contains identifier of type of this item. ReadOnly can be either TRUE (readonly ) or FALSE (read/ write). Name and/or Id contains textual and numerical identification of item.
  • IG_METAD_LEVEL_START - this value specifies that current item opens sublevel of items and all next items up to correspondent item with IG_METAD_LEVEL_END value belongs to this sublevel.
  • IG_METAD_LEVEL_END - this value close current sublevel and tells that next item belongs to higher level.
ItemValue If ItemType = IG_METAD_VALUE_ITEM then ItemValue contains actual value of item of type specified by ValueType parameter.Value is stored as array of elements where each element contains values of type ValueType. Length of array is provided in parameter ValueLength.
ValueType Type of element stored in array ItemValue.
ValueLength Length of array of elements stored in ItemValue.
ReadOnlyValue If this argument is TRUE then actual value of item can not be changed by callback function and value is passed for information purpose only. If FALSE then value of item can be changed and application can provide new value through next three parameters.

Return Value:

None

Supported Raster Image Formats:

This function does not process image pixels.

Sample:

JPEG

Example:

See example for IG_fltr_metad_callback_set() function.

Remarks:

ReadOnlyValue parameter is used to inform application that value of given item is for information only and can not be changed during future operations. It may allow to simplify future processing of this item at application level.

See also IG_fltr_metad_callback_get(), IG_fltr_metad_callback_set(), LPAFT_IG_METAD_ITEM_ADD_CB, LPAFT_IG_METAD_ITEM_SET_CB functions and the section Processing of non-image data through filter callback functions.

©2012. Accusoft Corporation. All Rights Reserved.