An Information Portal to Biological Macromolecular Structures
PDB Home | Contact Us		Software Tools Home  |  Dictionary Home  |  PDBML Home

GetItemEnumerationDetail

NAME GetItemEnumerationDetail

PROTOTYPE

#include "CifBuilder.h"

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

EXAMPLE

#include "CifBuilder.h"

CifBuilder cb("mmCif96.psf");

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

uWord numEnumeration = 0;
char ** enumDetail =
 cb.GetItemEnumerationDetail("_atom_site.cartn_x", numEnumeration);

PURPOSE

GetItemEnumerationDetail returns an array of descriptions for the enumeration of the item itemName.

RECEIVES

itemName	the name of the item
n	a reference to a uWord to hold the number of enumeration details

RETURN VALUE

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

REMARKS

See also:	GetItemEnumeration

 

© RCSB PDB