next up previous contents
Next: GetCategoryMandatoryCode Up: Category Access Methods Previous: Category Access Methods

GetCategoryDescription

NAME GetCategoryDescription

PROTOTYPE

#include "CifBuilder.h"

char * CifBuilder::GetCategoryDescription(const char * categoryId);

EXAMPLE

#include "CifBuilder.h"

CifBuilder cb("mmCif96.psf");

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

char * description = cb.GetCategoryDescription("atom_site");
PURPOSE

GetCategoryDescription returns the description of a category in the current context.

RECEIVES

categoryId the name of the category

RETURN VALUE

Returns the description of the category as a char *.

REMARKS

None



Olivera Tosic
6/13/2002