next up previous contents
Next: GetCategoryExamplesCase Up: Category Access Methods Previous: GetCategoryMandatoryCode

GetCategoryKeys

NAME GetCategoryKeys

PROTOTYPE

#include "CifBuilder.h"

char ** CifBuilder::GetCategoryKeys(const char * categoryId,
                                    uWord & n);

EXAMPLE

#include "CifBuilder.h"

CifBuilder cb("mmCif96.psf");

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

uWord numKeys = 0;
char ** keys = cb.GetCategoryKeys("atom_site", numKeys);
PURPOSE

GetCategoryKeys returns an array containing the item names that are the keys to the category categoryId.

RECEIVES

categoryId the name of the category
n a reference to a uWord to hold the number of keys

RETURN VALUE

Returns the keys as a char ** or NULL. The number of keys will be passed back via the second argument.

REMARKS

None



Olivera Tosic
6/13/2002