GpaGetPassCount

Syntax

Copied!

GpaStatus GpaGetPassCount(
    GpaSessionId session_id,
    GpaUInt32* num_passes);

Description

Gets the number of passes required for the currently enabled set of counters.

Parameters

Name

Description

session_id

Unique identifier of a previously-created session.

num_passes

The value which will hold the number of required passes upon successful execution.

Return value

Return value

Description

kGpaStatusOk

The pass count was successfully retrieved.

kGpaStatusErrorNullPointer
The supplied session_id parameter is NULL.
The supplied num_passes parameter is NULL.

kGpaStatusErrorSessionNotFound

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

kGpaStatusErrorContextNotOpen

The supplied session’s parent context is not currently open.

kGpaStatusErrorFailed

The pass count could not be retrieved.

kGpaStatusErrorException

Exception occurred.