next up previous contents
Next: GetItemType Up: Item Access Methods Previous: Item Access Methods

GetItemDescription

NAME GetItemDescription

PROTOTYPE

#include "CifBuilder.h"

char * CifBuilder::GetItemDescription(const char * itemName);

EXAMPLE

#include "CifBuilder.h"

CifBuilder cb("mmCif96.psf");

cb.BuildDictionaryList();
cb.SetContext("cifdic.m96");
char * description = cb.GetItemDescription("_atom_site.cartn_x");
PURPOSE

GetItemDescription returns the description for the item itemName in the current context

RECEIVES

itemName the name of the item

RETURN VALUE

Returns the description as a char * or NULL.

REMARKS

None



Olivera Tosic
6/13/2002