GpaGetCounterSampleType¶
Syntax¶
GpaStatus GpaGetCounterSampleType(
GpaContextId context_id,
GpaUInt32 index,
GpaCounterSampleType* counter_sample_type);
Description¶
Gets the sample type of the specified counter.
Parameters¶
| Name | Description |
|---|---|
context_id |
Unique identifier of a previously-opened context. |
index |
The index of the counter whose sample type is needed. Must lie between 0 and (GpaGetNumCounters result - 1). |
counter_sample_type |
The address which will hold the sample type upon successful execution. |
Return value¶
| Return value | Description |
|---|---|
| kGpaStatusOk | The counter sample type was successfully retrieved. |
| kGpaStatusErrorNullPointer | The supplied
counter_sample_type parameter is NULL.The supplied
context_id parameter is NULL. |
| kGpaStatusErrorContextNotFound | The supplied context_id parameter was not recognized as a previously-opened context identifier. |
| kGpaStatusErrorContextNotOpen | The supplied context is not currently open. |
| kGpaStatusErrorIndexOutOfRange | The specified index is out of range. |
| kGpaStatusErrorFailed | The counter sample type could not be retrieved. |
| kGpaStatusErrorException | Exception occurred. |