next up previous contents
Next: cifGetItemValueByIndex Up: CIFLIB Item Value Access Previous: CIFLIB Item Value Access

cifGetItemValue

NAME cifGetItemValue

PROTOTYPE

#include "ciflib.h"

int  cifGetItemValue(      char **value, 
                     const char  *dataBlockName, 
                     const char  *categoryName,
                     const char  *itemKeyword, 
                     const int    rowIndex)
PURPOSE

cifGetItemValue gets the address of the string representing the value of an item. The target item is identified by the name of the keyword, category, and data block in which it is defined. The row index is provided to select a particular item value when multiple values exist within the category. This function checks the integrity of the target item value with respect to the item's dictionary definition.

RECEIVES

value address of the string representing the value of the item
dataBlockName name of the target data block
categoryName name of the target category
itemKeyword name of the target item within the target category
rowIndex zero-based index of the target row

RETURN VALUE

Returns an integer CIFLIB error code. If the code CIF_DATA_IS_VALID is returned, then the value returned as a string is compliant with its dictionary definition.

REMARKS

See also: cifGetItemValueByIndex
  cifGetItemValueByAlias



Olivera Tosic
6/17/2002