GpaGetCounterName

Copyright (c) 2018-2024 Advanced Micro Devices, Inc. All rights reserved.

Syntax

GpaStatus GpaGetCounterName(
    GpaSessionId session_id,
    GpaUInt32 index,
    const char** name);

Description

Gets the name of the specified counter.

Parameters

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

Return value

Return value	Description
kGpaStatusOk	The counter name was successfully retrieved.
kGpaStatusErrorGpaNotInitialized	GPA was not initialized. Call GpaInitialize before all other entrypoints.
kGpaStatusErrorNullPointer	The supplied name 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 name could not be retrieved. | | kGpaStatusErrorException | Exception occurred. |