GpaGetCounterIndex
Syntax
GpaStatus GpaGetCounterIndex(GpaSessionId session_id, const char *counter_name, GpaUInt32 *index);Description
Gets index of a counter given its name (case insensitive).
Parameters
| Name | Description |
|---|---|
session_id | Unique identifier of a previously-created session. |
counter_name | The name of the counter whose index is needed. |
index | The address which will hold the index upon successful execution. |
Return value
| Return value | Description |
|---|---|
| kGpaStatusOk | The counter index was successfully retrieved. |
| kGpaStatusErrorGpaNotInitialized | GPA was not initialized. Call GpaInitialize before all other entrypoints. |
| kGpaStatusErrorNullPointer | The supplied counter_name parameter is NULL.The supplied index parameter is NULL.The supplied session_id parameter is NULL. |
kGpaStatusErrorSessionNotFound If the supplied session_id is invalid. | |
| kGpaStatusErrorCounterNotFound | The specified counter could not be found. |
| kGpaStatusErrorException | Exception occurred. |