next up previous contents
Next: GetItemEnumeration Up: Item Access Methods Previous: GetItemExamplesCase

GetItemExamplesDetail

NAME GetItemExamplesDetail

PROTOTYPE

#include "CifBuilder.h"

char ** CifBuilder::GetItemExamplesDetail(const char * itemName,
                                          uWord & n);

EXAMPLE

#include "CifBuilder.h"

CifBuilder cb("mmCif96.psf");

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

uWord numExamples = 0;
char ** examplesDetail =
 cb.GetItemExamplesDetail("_atom_site.cartn_x", numExamples);
PURPOSE

GetItemExamplesDetail returns an array of example details for the item itemName.

RECEIVES

itemName the name of the item
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: GetItemExamplesCase



Olivera Tosic
6/13/2002