GpaGetCounterDescription

Syntax

GpaStatus GpaGetCounterDescription(GpaSessionId session_id, GpaUInt32 index,
                                   const char **description);

Gets the description of the specified counter.

Name	Description
`session_id`	Unique identifier of a previously-created session.
`index`	The index of the counter whose description is needed. Must lie between 0 and (GpaGetNumCounters result - 1).
`description`	The address which will hold the description upon successful execution.

Return value	Description
kGpaStatusOk	The counter description was successfully retrieved.
kGpaStatusErrorGpaNotInitialized	GPA was not initialized. Call GpaInitialize before all other entrypoints.
kGpaStatusErrorNullPointer	The supplied `description` parameter is NULL.The supplied `session_id` parameter is NULL.
kGpaStatusErrorSessionNotFound If the supplied `session_id` is invalid.
kGpaStatusErrorIndexOutOfRange	The specified index is out of range.
kGpaStatusErrorFailed	The counter description could not be retrieved.
kGpaStatusErrorException	Exception occurred.