GetDictionaryCategoryGroupListDescription

NAME GetDictionaryCategoryGroupListDescription

PROTOTYPE

#include "CifBuilder.h"

char ** CifBuilder::GetDictionaryCategoryGroupListDescription(uWord & n);

EXAMPLE

#include "CifBuilder.h"

CifBuilder cb("mmCif96.psf");

cb.BuildDictionaryList();
cb.SetContext("cifdic.m96");

uWord numGroups = 0;
char ** CategoryGroupListDescription = 
 cb.GetDictionaryCategoryGroupListDescription(numGroups);

PURPOSE

GetDictionaryCategoryGroupListDescription returns an array of char *, which is a list of the descriptions of the category groups in the current dictionary datablock (context).

RECEIVES

n	a reference to a uWord to hold the number of category groups

RETURN VALUE

Returns the list of category group descriptions as a char ** or NULL. The number of groups will be passed back via the argument.

REMARKS

See also:	GetDictionaryCategoryGroupList
	GetDictionaryCategoryGroupListParents