GpaGetDeviceName

Syntax

Copied!

GpaStatus GpaGetDeviceName(
    GpaContextId context_id,
    const char** device_name);

Description

Gets the device name of the GPU associated with the specified context.

Parameters

Name

Description

context_id

Unique identifier of a previously-opened context.

device_name

The value that will be set to the device name upon successful execution.

Return value

Return value

Description

kGpaStatusOk

The device name was successfully retrieved.

kGpaStatusErrorNullPointer
The supplied device_name parameter is NULL.
The supplied context_id parameter is NULL.

kGpaStatusErrorContextNotOpen

The supplied context is not currently open.

kGpaStatusErrorContextNotFound

The supplied context_id parameter was not recognized as a previously-opened context identifier.

kGpaStatusErrorFailed

The device name could not be retrieved.

kGpaStatusErrorException

Exception occurred.