Skip to content

GpaGetPassCount

Copyright (c) 2018-2024 Advanced Micro Devices, Inc. All rights reserved.

Syntax

GpaStatus GpaGetPassCount(
GpaSessionId session_id,
GpaUInt32* num_passes);

Description

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

Parameters

NameDescription
session_idUnique identifier of a previously-created session.
num_passesThe value which will hold the number of required passes upon successful execution.

Return value

Return valueDescription
kGpaStatusOkThe pass count was successfully retrieved.
kGpaStatusErrorGpaNotInitializedGPA was not initialized. Call GpaInitialize before all other entrypoints.
kGpaStatusErrorNullPointerThe 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. |