next up previous contents
Next: cifGetItemAliasNamesByIndex Up: CIFLIB Item Access Functions Previous: cifGetItemAliasNameByIndex

cifGetItemAliasNames

NAME cifGetItemAliasNames

PROTOTYPE

#include "ciflib.h"

char **cifGetItemAliasNames(const char *dataBlockName, 
                            const char *categoryName, 
                                  int  *numItem);
PURPOSE

cifGetItemAliasNames returns an array of item names within the target category within the target data block. If an item has been declared using a valid alias name, then that alias name is returned by this function. This behavior differs from cifGetItemNames which always returns item names defined in the current dictionary even if those items have been declared using alias names. The category and data block are identified by name.

RECEIVES

dataBlockName name of the target data block
categoryName name of the target category
numItem integer pointer to hold returned number of item names

RETURN VALUE

Returns an array of item names or a NULL value for failure. If the operation is successful the number of item names is returned in numItem.

REMARKS

See also: cifGetItemAliasNamesByIndex



Olivera Tosic
6/17/2002