GpaDeleteSession¶
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¶
| Name | Description |
|---|---|
session_id |
Unique identifier of a previously-created session. |
Return value¶
| Return value | Description |
|---|---|
| kGpaStatusOk | The session was successfully deleted. |
| kGpaStatusErrorNullPointer | The supplied session_id parameter is NULL. |
| kGpaStatusErrorSessionNotFound | The supplied session_id parameter was not recognized as a previously-created session identifier. |
| kGpaStatusErrorFailed | The session could not be deleted. |
| kGpaStatusErrorException | Exception occurred. |