Name

cgGetDomain - get the domain enumerant from a domain name

Synopsis

#include <Cg/cg.h>

CGdomain cgGetDomain( const char * domain_string );

Parameters

domain_string

A string containing the case-sensitive domain name.

Return Values

Returns the domain enumerant of domain_string.

Returns CG_UNKNOWN if the given domain does not exist.

Description

cgGetDomain returns the enumerant assigned to a domain name.

Examples

CGdomain ARBVP1domain = cgGetDomain("arbvp1");

if(cgGetProgramDomain(myprog) == ARBVP1Domain)
{
  /* Do stuff */
}

Errors

CG_INVALID_PARAMETER_ERROR is generated if domain_string is NULL.

History

cgGetDomain was introduced in Cg 2.2.

See Also

cgGetDomainString, cgGetProgramDomain