NAME

cgGetStringParameterValue - get the value of a string parameter

SYNOPSIS

  #include <Cg/cg.h>

  const char * cgGetStringParameterValue( CGparameter param );

PARAMETERS

param

The parameter whose value will be retrieved.

RETURN VALUES

A constant pointer to the parameter's string is returned.

DESCRIPTION

cgGetStringParameterValue allows the application to get the value of a string parameter.

EXAMPLES

to-be-written

ERRORS

CG_INVALID_PARAM_HANDLE_ERROR is generated if the handle param is invalid.

CG_INVALID_PARAMETER_TYPE_ERROR is generated if the type of the given parameter is not CG_STRING.

HISTORY

cgGetStringParameterValue was introduced in Cg 1.4.

SEE ALSO

cgSetStringParameterValue