GpaEndSample

语法

GpaStatus GpaEndSample(
    GpaCommandListId command_list_id);

描述

结束命令列表中的一个样本。样本是指将收集计数器数据的特定工作负载。如果拥有会话时启用了 kGpaSessionSampleTypeDiscreteCounter 并且已启用一个或多个计数器，那么将为此样本收集这些计数器。每个样本必须与一个 GPA 命令列表相关联。如果没有任何两个线程在同一命令列表上创建样本，则可以通过多个线程创建样本。您必须为每个新样本提供一个唯一 ID。您可以创建任意数量的样本。但是，不允许嵌套样本。每个样本都必须在开始另一个样本之前用 GpaBeginSample/GpaEndSample 序列进行封装。样本可以在一个主命令列表中开始，并在另一个主命令列表中继续/结束 - 请参阅 GpaContinueSampleOnCommandList。

参数

名称	描述
command_list_id	先前创建的命令列表的唯一标识符。

返回值

返回值	描述
kGpaStatusOk	样本已成功结束。
kGpaStatusErrorGpaNotInitialized	GPA 未初始化。请在所有其他入口点之前调用 GpaInitialize。
kGpaStatusErrorNullPointer	提供的 command_list_id 参数为 NULL。
kGpaStatusErrorCommandListNotFound	提供的 command_list_id 参数未被识别为先前创建的命令列表标识符。
kGpaStatusErrorIndexOutOfRange	指定的命令列表的传递索引超出范围。
kGpaStatusErrorFailed	无法开始该样本。
kGpaStatusErrorException	发生异常。