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

GetItemEnumeration

NAME GetItemEnumeration

PROTOTYPE

#include "CifBuilder.h"

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

EXAMPLE

#include "CifBuilder.h"

CifBuilder cb("mmCif96.psf");

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

uWord numEnumeration = 0;
char ** enumeration = cb.GetItemEnumeration("_atom_site.cartn_x",
                                             numEnumeration);

PURPOSE

GetItemEnumeration returns an enumeration for the item itemName as an array of char *.

RECEIVES

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

RETURN VALUE

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

REMARKS

See also:	GetItemEnumerationDetail

 

© RCSB PDB