NVML API Reference Guide (PDF) - v535 (older) - Last updated January 31, 2024 - Send Feedback

4.21. Field Value Queries

This chapter describes NVML operations that are associated with retrieving Field Values from NVML

Functions

nvmlReturn_t nvmlDeviceClearFieldValues ( nvmlDevice_t device, int  valuesCount, nvmlFieldValue_t* values )
nvmlReturn_t nvmlDeviceGetFieldValues ( nvmlDevice_t device, int  valuesCount, nvmlFieldValue_t* values )

Functions

nvmlReturn_t nvmlDeviceClearFieldValues ( nvmlDevice_t device, int  valuesCount, nvmlFieldValue_t* values )
Parameters
device
The device handle of the GPU to request field values for
valuesCount
Number of entries in values that should be cleared
values
Array of valuesCount structures to hold field values. Each value's fieldId must be populated prior to this call
Returns

  • NVML_SUCCESS if any values in values were cleared. Note that you must check the nvmlReturn field of each value for each individual status
  • NVML_ERROR_INVALID_ARGUMENT if device is invalid or values is NULL

Description

Clear values for a list of fields for a device. This API allows multiple fields to be cleared at once.

nvmlReturn_t nvmlDeviceGetFieldValues ( nvmlDevice_t device, int  valuesCount, nvmlFieldValue_t* values )
Parameters
device
The device handle of the GPU to request field values for
valuesCount
Number of entries in values that should be retrieved
values
Array of valuesCount structures to hold field values. Each value's fieldId must be populated prior to this call
Returns

  • NVML_SUCCESS if any values in values were populated. Note that you must check the nvmlReturn field of each value for each individual status
  • NVML_ERROR_INVALID_ARGUMENT if device is invalid or values is NULL

Description

Request values for a list of fields for a device. This API allows multiple fields to be queried at once. If any of the underlying fieldIds are populated by the same driver call, the results for those field IDs will be populated from a single call rather than making a driver call for each fieldId.


NVML API Reference Guide (PDF) - v535 (older) - Last updated January 31, 2024 - Send Feedback