GpaStatus GpaIsCounterEnabled(
    GpaSessionId session_id,
    GpaUInt32 counter_index);


Checks whether or not a counter is enabled.


Name Description
session_id Unique identifier of a previously-created session.
counter_index The index of the counter. Must lie between 0 and (GpaGetNumCounters result - 1).

Return value

Return value Description
kGpaStatusOk The specified counter is enabled.
kGpaStatusErrorCounterNotFound The specified counter is not enabled.
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.
kGpaStatusErrorContextNotOpen The supplied session’s parent context is not currently open.
kGpaStatusErrorIndexOutOfRange The specified index is out of range.
kGpaStatusErrorFailed An error occurred while trying to retrieve the enabled status of the specified counter.
kGpaStatusErrorException Exception occurred.