next up previous contents
Next: GetItemRelatedFunctionCode Up: Item Access Methods Previous: GetItemDependents

GetItemRelated

NAME GetItemRelated

PROTOTYPE

#include "CifBuilder.h"

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

EXAMPLE

#include "CifBuilder.h"

CifBuilder cb("mmCif96.psf");

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

uWord numRelated = 0;
char ** related = cb.GetItemRelated("_atom_site.cartn_x",
                                    numRelated);
PURPOSE

GetItemRelated returns an array containing the names of the related items for the item itemName.

RECEIVES

itemName the name of the item
n a reference to a uWord to hold the number of related items

RETURN VALUE

Returns the related item names as a char ** or NULL. The number of related items will be passed back via the second argument.

REMARKS

See also: GetItemRelatedFunctionCode



Olivera Tosic
6/13/2002