Skip to content

GpaDeleteSession

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

Syntax

GpaStatus GpaDeleteSession(
GpaSessionId session_id);

Description

Deletes a session object. Deletes the specified session, along with all counter results associated with the session.

Parameters

NameDescription
session_idUnique identifier of a previously-created session.

Return value

Return valueDescription
kGpaStatusOkThe session was successfully deleted.
kGpaStatusErrorGpaNotInitializedGPA was not initialized. Call GpaInitialize before all other entrypoints.
kGpaStatusErrorNullPointerThe supplied session_id parameter is NULL.
kGpaStatusErrorSessionNotFoundThe supplied session_id parameter was not recognized as a previously-created session identifier.
kGpaStatusErrorFailedThe session could not be deleted.
kGpaStatusErrorExceptionException occurred.