GpaGetCounterDescription
Syntax
Copied!
GpaStatus GpaGetCounterDescription(
GpaSessionId session_id,
GpaUInt32 index,
const char** description);
Description
Gets the description of the specified counter.
Parameters
|
Name |
Description |
|---|---|
|
|
Unique identifier of a previously-created session. |
|
|
The index of the counter whose description is needed. Must lie between 0 and (GpaGetNumCounters result – 1). |
|
|
The address which will hold the description upon successful execution. |
Return value
|
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 |
|
|
kGpaStatusErrorIndexOutOfRange |
The specified index is out of range. |
|
kGpaStatusErrorFailed |
The counter description could not be retrieved. |
|
kGpaStatusErrorException |
Exception occurred. |
