NVAPI Reference Documentation
NVIDIA
Release 470: June 28
2021

Functions
GRID License APIs

Functions

NVAPI_INTERFACE NvAPI_GPU_GetLicensableFeatures (__in NvPhysicalGpuHandle hPhysicalGpu, __inout NV_LICENSABLE_FEATURES *pLicensableFeatures)
 
#define NV_LICENSE_MAX_COUNT   3
 
#define NV_LICENSE_SIGNATURE_SIZE   (128)
 
#define NV_LICENSE_INFO_MAX_LENGTH   (128)
 
#define NV_LICENSE_FEATURE_DETAILS_VER1   MAKE_NVAPI_VERSION(NV_LICENSE_FEATURE_DETAILS_V1, 1)
 
#define NV_LICENSE_FEATURE_DETAILS_VER   NV_LICENSE_FEATURE_DETAILS_VER1
 
#define NV_LICENSABLE_FEATURES_VER1   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V1, 1)
 
#define NV_LICENSABLE_FEATURES_VER2   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V2, 2)
 
#define NV_LICENSABLE_FEATURES_VER3   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V3, 3)
 
#define NV_LICENSABLE_FEATURES_VER   NV_LICENSABLE_FEATURES_VER3
 
enum  _NV_LICENSE_FEATURE_TYPE {
  NV_LICENSE_FEATURE_UNKNOWN = 0, NV_LICENSE_FEATURE_VGPU = 1, NV_LICENSE_FEATURE_NVIDIA_RTX = 2, NV_LICENSE_FEATURE_QUADRO = NV_LICENSE_FEATURE_NVIDIA_RTX,
  NV_LICENSE_FEATURE_GAMING = 3
}
 
typedef char NvAPI_LicenseString[NV_LICENSE_INFO_MAX_LENGTH]
 
typedef enum _NV_LICENSE_FEATURE_TYPE NV_LICENSE_FEATURE_TYPE
 
typedef struct _NV_LICENSE_FEATURE_DETAILS_V1 NV_LICENSE_FEATURE_DETAILS_V1
 
typedef struct _NV_LICENSE_FEATURE_DETAILS_V2 NV_LICENSE_FEATURE_DETAILS_V2
 
typedef struct _NV_LICENSE_FEATURE_DETAILS_V3 NV_LICENSE_FEATURE_DETAILS_V3
 
typedef NV_LICENSE_FEATURE_DETAILS_V1 NV_LICENSE_FEATURE_DETAILS
 
typedef struct _NV_LICENSABLE_FEATURES_V1 NV_LICENSABLE_FEATURES_V1
 
typedef struct _NV_LICENSABLE_FEATURES_V2 NV_LICENSABLE_FEATURES_V2
 
typedef struct _NV_LICENSABLE_FEATURES_V3 NV_LICENSABLE_FEATURES_V3
 
typedef NV_LICENSABLE_FEATURES_V3 NV_LICENSABLE_FEATURES
 

Detailed Description

Interface to the NVIDIA GRID licensing feature

Macro Definition Documentation

#define NV_LICENSABLE_FEATURES_VER   NV_LICENSABLE_FEATURES_VER3

Maximum number of supported Feature License.

#define NV_LICENSABLE_FEATURES_VER1   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V1, 1)

Maximum number of supported Feature License.

#define NV_LICENSABLE_FEATURES_VER2   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V2, 2)

Maximum number of supported Feature License.

#define NV_LICENSABLE_FEATURES_VER3   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V3, 3)

Maximum number of supported Feature License.

#define NV_LICENSE_FEATURE_DETAILS_VER   NV_LICENSE_FEATURE_DETAILS_VER1

Maximum number of supported Feature License.

#define NV_LICENSE_FEATURE_DETAILS_VER1   MAKE_NVAPI_VERSION(NV_LICENSE_FEATURE_DETAILS_V1, 1)

Maximum number of supported Feature License.

#define NV_LICENSE_INFO_MAX_LENGTH   (128)

Length for Grid License.

#define NV_LICENSE_MAX_COUNT   3

Maximum number of supported Feature License.

#define NV_LICENSE_SIGNATURE_SIZE   (128)

Signature length for GRID License.

Typedef Documentation

Maximum number of supported Feature License.

Licensable features.

Maximum number of supported Feature License.

Maximum number of supported Feature License.

Maximum number of supported Feature License.

Used in NV_LICENSABLE_FEATURES.

Maximum number of supported Feature License.

Maximum number of supported Feature License.

Used in NV_LICENSE_FEATURE_DETAILS.

typedef char NvAPI_LicenseString[NV_LICENSE_INFO_MAX_LENGTH]

License string.

Enumeration Type Documentation

Used in NV_LICENSE_FEATURE_DETAILS.

Enumerator
NV_LICENSE_FEATURE_UNKNOWN 
NV_LICENSE_FEATURE_VGPU 
NV_LICENSE_FEATURE_NVIDIA_RTX 
NV_LICENSE_FEATURE_QUADRO 

DEPRECATED name - do not use.

NV_LICENSE_FEATURE_GAMING 

Function Documentation

NVAPI_INTERFACE NvAPI_GPU_GetLicensableFeatures ( __in NvPhysicalGpuHandle  hPhysicalGpu,
__inout NV_LICENSABLE_FEATURES pLicensableFeatures 
)

DESCRIPTION: This function call identifies whether licenses are supported on this system and if they are supported, returns the details of the features that can be licensed.

SUPPORTED OS: Windows 7 and higher

Parameters
[in]hPhysicalGpuGPU selection
[in,out]pLicensableFeaturesLicensable features information.
Returns
This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.


Copyright (c) 2007-2021 NVIDIA Corporation. All rights reserved.

NVIDIA