cifGetItemValueByIndex

NAME cifGetItemValueByIndex

PROTOTYPE

#include "ciflib.h"

int  cifGetItemValueByIndex(      char **value, 
                            const int    dataBlockIndex, 
                            const int    categoryIndex,
                            const int    itemIndex, 
                            const int    rowIndex)

PURPOSE

cifGetItemValue gets the address of the string representing the value of an item. The target item is identified by the index 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
dataBlockIndex	zero-based index of the target data block
categoryIndex	zero-based index of the target category
itemIndex	zero-based index 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:	cifGetItemValue
	cifGetItemValueByAlias