RCSB PDB Protein Data Bank A Member of the wwPDB
An Information Portal to Biological Macromolecular Structures
PDB Home | Contact Us
next up previous contents
Next: GetItemAliasesDictionary Up: Item Access Methods Previous: GetItemRangeMax

GetItemAliases

NAME GetItemAliases

PROTOTYPE

#include "CifBuilder.h"

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

EXAMPLE

#include "CifBuilder.h"

CifBuilder cb("mmCif96.psf");

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

uWord numAliases = 0;
char ** aliases = cb.GetItemAliases("_atom_site.cartn_x",
                                    numAliases);
PURPOSE

GetItemAliases returns an array containing the aliases for the item itemName.

RECEIVES

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

RETURN VALUE

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

REMARKS

See also: GetItemAliasesDictionary
  GetItemAliasesDictionaryVersion



Olivera Tosic
6/13/2002

 

© RCSB PDB