GpaGetCounterUsageType
Copyright (c) 2018-2024 Advanced Micro Devices, Inc. All rights reserved.
Syntax
GpaStatus GpaGetCounterUsageType( GpaSessionId session_id, GpaUInt32 index, GpaUsageType* counter_usage_type);
Description
Gets the usage type of the specified counter. The usage type indicates the units used for the counter.
Parameters
Name | Description |
---|---|
session_id | Unique identifier of a previously-created session. |
index | The index of the counter whose usage type is needed. Must lie between 0 and (GpaGetNumCounters result - 1). |
counter_usage_type | The address which will hold the usage type upon successful execution. |
Return value
Return value | Description |
---|---|
kGpaStatusOk | The counter usage type was successfully retrieved. |
kGpaStatusErrorGpaNotInitialized | GPA was not initialized. Call GpaInitialize before all other entrypoints. |
kGpaStatusErrorNullPointer | The supplied counter_usage_type 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 usage type could not be retrieved. | | kGpaStatusErrorException | Exception occurred. |