Name

cgGetStringAnnotationValue - get a string-valued annotation's value

Synopsis

#include <Cg/cg.h>

const char * cgGetStringAnnotationValue( CGannotation ann );

Parameters

ann

The annotation.

Return Values

Returns a pointer to a string contained by ann.

Returns NULL if no value is available.

Description

cgGetStringAnnotationValue allows the application to retrieve the value of a string typed annotation.

Examples

to-be-written

Errors

CG_INVALID_ANNOTATION_HANDLE_ERROR is generated if ann is not a valid annotation.

History

cgGetStringAnnotationValue was introduced in Cg 1.4.

See Also

cgGetAnnotationType, cgGetStringAnnotationValues, cgGetFloatAnnotationValues, cgGetIntAnnotationValues, cgGetBoolAnnotationValues