GpaGetSampleId
Copyright (c) 2018-2024 Advanced Micro Devices, Inc. 保留所有权利。
语法
GpaStatus GpaGetSampleId( GpaSessionId session_id, GpaUInt32 index, GpaUInt32* sample_id);描述
获取具有指定索引的样本的样本 ID。如果样本 ID 不是从零开始的,或者不是连续的,这会很有用。
参数
| 名称 | 描述 |
|---|---|
| session_id | 先前创建的会话的唯一标识符。 |
| index | 需要其样本 ID 的样本的基于零的索引。必须介于 0 和 (GpaGetSampleCount 的结果 - 1) 之间。 |
| sample_id | 成功执行后,将保存样本 ID 的值。 |
返回值
| 返回值 | 描述 |
|---|---|
| kGpaStatusOk | 样本 ID 已成功检索。 |
| kGpaStatusErrorGpaNotInitialized | GPA 未初始化。请在所有其他入口点之前调用 GpaInitialize。 |
| kGpaStatusErrorNullPointer | 提供的 session_id 参数为 NULL。 |
提供的 sample_id 参数为 NULL。 | | kGpaStatusErrorSessionNotFound | 提供的 session_id 参数未被识别为先前创建的会话标识符。 | | kGpaStatusErrorSessionNotStarted | 会话尚未开始。 | | kGpaStatusErrorSampleNotFound | 未找到指定的样本。 | | kGpaStatusErrorException | 发生异常。 |