GpaIsPassComplete

Syntax

GpaStatus GpaIsPassComplete(
    GpaSessionId session_id,
    GpaUInt32 pass_index);

Description

Checks whether or not a pass has finished. After sampling a workload, results may be available immediately or take a certain amount of time to become available. This function allows you to determine when the pass has finished and associated resources are no longer needed in the application. The function does not block, permitting periodic polling. The application must not free its resources until this function returns kGpaStatusOk.

Parameters

Name	Description
session_id	Unique identifier of a previously-created session.
pass_index	Zero-based index of the pass to check.

Return value

Return value	Description
kGpaStatusOk	The pass is complete and results are ready.
kGpaStatusErrorGpaNotInitialized	GPA was not initialized. Call GpaInitialize before all other entrypoints.
kGpaStatusErrorResultNotReady	The pass is not yet ready.
kGpaStatusErrorNullPointer	The supplied session_id parameter is NULL.
kGpaStatusErrorSessionNotFound	The supplied session_id parameter was not recognized as a previously-created session identifier.
kGpaStatusErrorSessionNotStarted	The session has not been started.
kGpaStatusErrorException	Exception occurred.