GpaEnableCounterByName
Syntax
Copied!
GpaStatus GpaEnableCounterByName(
GpaSessionId session_id,
const char* counter_name);
Description
Enables the counter with the specified counter name (case insensitive). Subsequent sampling sessions will provide values for any enabled counters. Initially all counters are disabled, and must explicitly be enabled.
Parameters
|
Name |
Description |
|---|---|
|
|
Unique identifier of a previously-created session. |
|
|
The name of the counter to enable. |
Return value
|
Return value |
Description |
|---|---|
|
kGpaStatusOk |
The specified counter was successfully enabled. |
|
kGpaStatusErrorNullPointer |
The supplied |
|
kGpaStatusErrorSessionNotFound |
The supplied |
|
kGpaStatusErrorCannotChangeCountersWhenSampling |
The set of enabled counters cannot be changed after GpaBeginSession is called. |
|
kGpaStatusErrorContextNotOpen |
The supplied session’s parent context is not currently open. |
|
kGpaStatusErrorAlreadyEnabled |
The specified counter was already enabled. |
|
kGpaStatusErrorIncompatibleSampleTypes |
The supplied session was not created with a GpaSessionSampleType value that supports counter collection. |
|
kGpaStatusErrorCounterNotFound |
The specified counter name is not valid. |
|
kGpaStatusErrorFailed |
An error occurred while trying to enable the counter. |
|
kGpaStatusErrorException |
Exception occurred. |
