NAME

cgGetNamedParameterAnnotation - get a parameter annotation by name

SYNOPSIS

  #include <Cg/cg.h>

  CGannotation cgGetNamedParameterAnnotation( CGparameter param, const char * name );

PARAMETERS

param

Specifies the parameter to retrieve the annotation from.

name

Specifies the name of the annotation to retrieve.

DESCRIPTION

The annotations associated with a parameter can be retrieved directly by name using the cgGetNamedParameterAnnotation function. The names of a parameter's annotations can be discovered by iterating through the annotations (see the "cgGetFirstParameterAnnotation" document and the "cgGetNextAnnotation" document), calling cgGetAnnotationName for each one in turn.

RETURN VALUES

Returns the named annotation. If the parameter has no annotation corresponding to name, NULL is returned.

ERRORS

CG_INVALID_PARAMETER_HANDLE_ERROR is generated if param does not refer to a valid parameter.

SEE ALSO

the "cgGetFirstParameterAnnotation" document, the "cgGetNextParameterAnnotation" document, the "cgGetAnnotationName" document