GetCategoryExamplesDetail

NAME GetCategoryExamplesDetail

PROTOTYPE

#include "CifBuilder.h"

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

EXAMPLE

#include "CifBuilder.h"

CifBuilder cb("mmCif96.psf");

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

uWord numExamples = 0;
char ** examplesDetail = cb.GetCategoryExamplesDetail("atom_site",
                                                     numExamples);

PURPOSE

GetCategoryExamplesDetail returns an array of example details for the category categoryId.

RECEIVES

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

RETURN VALUE

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

REMARKS

See also:	GetCategoryExamplesCase