nvmlSystemQueries (3)

NAME

System Queries -

Functions

nvmlReturn_t DECLDIR nvmlSystemGetDriverVersion (char *version, unsigned int length)

nvmlReturn_t DECLDIR nvmlSystemGetNVMLVersion (char *version, unsigned int length)

nvmlReturn_t DECLDIR nvmlSystemGetProcessName (unsigned int pid, char *name, unsigned int length)

Detailed Description

This chapter describes the queries that NVML can perform against the local system. These queries are not device-specific.

Function Documentation

nvmlReturn_t DECLDIR nvmlSystemGetDriverVersion (char * version, unsigned int length)

Retrieves the version of the system's graphics driver.

For all products.

The version identifier is an alphanumeric string. It will not exceed 80 characters in length (including the NULL terminator). See nvmlConstants::NVML_SYSTEM_DRIVER_VERSION_BUFFER_SIZE.

Parameters:

version Reference in which to return the version identifier
length The maximum allowed length of the string returned in version

Returns:

*

NVML_SUCCESS if version has been set

*

NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized

*

NVML_ERROR_INVALID_ARGUMENT if version is NULL

*

NVML_ERROR_INSUFFICIENT_SIZE if length is too small

nvmlReturn_t DECLDIR nvmlSystemGetNVMLVersion (char * version, unsigned int length)

Retrieves the version of the NVML library.

For all products.

The version identifier is an alphanumeric string. It will not exceed 80 characters in length (including the NULL terminator). See nvmlConstants::NVML_SYSTEM_NVML_VERSION_BUFFER_SIZE.

Parameters:

version Reference in which to return the version identifier
length The maximum allowed length of the string returned in version

Returns:

*

NVML_SUCCESS if version has been set

*

NVML_ERROR_INVALID_ARGUMENT if version is NULL

*

NVML_ERROR_INSUFFICIENT_SIZE if length is too small

nvmlReturn_t DECLDIR nvmlSystemGetProcessName (unsigned int pid, char * name, unsigned int length)

Gets name of the process with provided process id

For all products.

Returned process name is cropped to provided length. name string is encoded in ANSI.

Parameters:

pid The identifier of the process
name Reference in which to return the process name
length The maximum allowed length of the string returned in name

Returns:

*

NVML_SUCCESS if name has been set

*

NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized

*

NVML_ERROR_INVALID_ARGUMENT if name is NULL or length is 0.

*

NVML_ERROR_NOT_FOUND if process doesn't exists

*

NVML_ERROR_NO_PERMISSION if the user doesn't have permission to perform this operation

*

NVML_ERROR_UNKNOWN on any unexpected error

Author

Generated automatically by Doxygen for NVML from the source code.