GpaGetCounterIndex

Syntax

Copied!

GpaStatus GpaGetCounterIndex(
    GpaContextId context_id,
    const char* counter_name,
    GpaUInt32* index);

Description

Gets index of a counter given its name (case insensitive).

Parameters

Name

Description

context_id

Unique identifier of a previously-opened context.

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.

kGpaStatusErrorNullPointer
The supplied counter_name parameter is NULL.
The supplied index 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.

kGpaStatusErrorCounterNotFound

The specified counter could not be found.

kGpaStatusErrorException

Exception occurred.