Metric Group - Deprecated

oneAPI Level Zero Specification - Version 1.20.41

Metric Group - Deprecated Functions

zetMetricGroupCreateExp

Added in version 1.9

Deprecated since 1.12. Use zetDeviceCreateMetricGroupsFromMetricsExp instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zetMetricGroupCreateExp(zet_device_handle_t hDevice, const char *pName, const char *pDescription, zet_metric_group_sampling_type_flags_t samplingType, zet_metric_group_handle_t *phMetricGroup)

Create metric group handle.

Parameters:

• hDevice – [in] handle of the device

• pName – [in] pointer to metric group name. Must point to a null-terminated character array no longer than ZET_MAX_METRIC_GROUP_NAME.

• pDescription – [in] pointer to metric group description. Must point to a null-terminated character array no longer than ZET_MAX_METRIC_GROUP_DESCRIPTION.

• samplingType – [in] Sampling type for the metric group.

• phMetricGroup – [in,out] Created Metric group handle

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

• ZE_RESULT_ERROR_NOT_AVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hDevice

• ZE_RESULT_ERROR_INVALID_NULL_POINTER

  • nullptr == pName

  • nullptr == pDescription

  • nullptr == phMetricGroup

• ZE_RESULT_ERROR_INVALID_ENUMERATION

  • 0x7 < samplingType

• ZE_RESULT_ERROR_UNSUPPORTED_ENUMERATION