next up previous contents
Next: GetItemAliasesDictionaryVersion Up: Item Access Methods Previous: GetItemAliases

GetItemAliasesDictionary

NAME GetItemAliasesDictionary

PROTOTYPE

#include "CifBuilder.h"

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

EXAMPLE

#include "CifBuilder.h"

CifBuilder cb("mmCif96.psf");

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

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

GetItemAliasesDictionary returns an array containing the names of the dictionaries from which the aliases of the item itemName came.

RECEIVES

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

RETURN VALUE

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

REMARKS

See also: GetItemAliases
  GetItemAliasesDictionaryVersion



Olivera Tosic
6/13/2002