NVML API Reference Guide (PDF) - vR470 (older) - Last updated July 29, 2021 - Send Feedback

3.13. nvmlFieldValue_t Struct Reference

[Field Value Enums]

Information for a Field Value Sample

Public Variables

unsigned int  fieldId
ID of the NVML field to retrieve. This must be set before any call that uses this struct. See the constants starting with NVML_FI_ above.
long long  latencyUsec
How long this field value took to update (in usec) within NVML. This may be averaged across several fields that are serviced by the same driver call.
nvmlReturn_t nvmlReturn
Return code for retrieving this value. This must be checked before looking at value, as value is undefined if nvmlReturn != NVML_SUCCESS.
unsigned int  scopeId
Scope ID can represent data used by NVML depending on fieldId's context. For example, for NVLink throughput counter data, scopeId can represent linkId.
long long  timestamp
CPU Timestamp of this value in microseconds since 1970.
union nvmlValue_t value
Value for this field. This is only valid if nvmlReturn == NVML_SUCCESS.
nvmlValueType_t valueType
Type of the value stored in value.

Variables

unsigned int nvmlFieldValue_t::fieldId [inherited]

ID of the NVML field to retrieve. This must be set before any call that uses this struct. See the constants starting with NVML_FI_ above.

long long nvmlFieldValue_t::latencyUsec [inherited]

How long this field value took to update (in usec) within NVML. This may be averaged across several fields that are serviced by the same driver call.

nvmlReturn_tnvmlFieldValue_t::nvmlReturn [inherited]

Return code for retrieving this value. This must be checked before looking at value, as value is undefined if nvmlReturn != NVML_SUCCESS.

unsigned int nvmlFieldValue_t::scopeId [inherited]

Scope ID can represent data used by NVML depending on fieldId's context. For example, for NVLink throughput counter data, scopeId can represent linkId.

long long nvmlFieldValue_t::timestamp [inherited]

CPU Timestamp of this value in microseconds since 1970.

union nvmlValue_tnvmlFieldValue_t::value [inherited]

Value for this field. This is only valid if nvmlReturn == NVML_SUCCESS.

nvmlValueType_tnvmlFieldValue_t::valueType [inherited]

Type of the value stored in value.


NVML API Reference Guide (PDF) - vR470 (older) - Last updated July 29, 2021 - Send Feedback