GpaDisableCounter

Syntax

Copied!

GpaStatus GpaDisableCounter(
    GpaSessionId session_id,
    GpaUInt32 index);

Description

Disables the specified counter. Subsequent sampling sessions will not provide values for any disabled counters. Initially all counters are disabled, and must explicitly be enabled.

Parameters

Name

Description

session_id

Unique identifier of a previously-created session.

index

The index of the counter to disable. Must lie between 0 and (GpaGetNumCounters result – 1).

Return value

Return value

Description

kGpaStatusOk

The counter was successfully disabled.

kGpaStatusErrorNullPointer

The supplied session_id parameter is NULL.

kGpaStatusErrorSessionNotFound

The supplied session_id parameter was not recognized as a previously-created session identifier.

kGpaStatusErrorCannotChangeCountersWhenSampling

The set of enabled counters cannot be changed after GpaBeginSession is called.

kGpaStatusErrorIndexOutOfRange

The specified index is out of range.

kGpaStatusErrorNotEnabled

The specified counter is not currently enabled.

kGpaStatusErrorFailed

An error occurred while trying to disable the counter.

kGpaStatusErrorException

Exception occurred.