.TH "GPU Blacklist Queries" 3 "24 Apr 2019" "Version 1.1" "NVML" \" -*- nroff -*-
.ad l
.nh
.SH NAME
GPU Blacklist Queries \- 
.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBnvmlBlacklistDeviceInfo_t\fP"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBnvmlReturn_t\fP DECLDIR \fBnvmlGetBlacklistDeviceCount\fP (unsigned int *deviceCount)"
.br
.ti -1c
.RI "\fBnvmlReturn_t\fP DECLDIR \fBnvmlGetBlacklistDeviceInfoByIndex\fP (unsigned int index, \fBnvmlBlacklistDeviceInfo_t\fP *info)"
.br
.in -1c
.SH "Detailed Description"
.PP 
This chapter describes NVML operations that are associated with blacklisted GPUs. 
.SH "Function Documentation"
.PP 
.SS "\fBnvmlReturn_t\fP DECLDIR nvmlGetBlacklistDeviceCount (unsigned int * deviceCount)"
.PP
Retrieves the number of blacklisted GPU devices in the system.
.PP
For all products.
.PP
\fBParameters:\fP
.RS 4
\fIdeviceCount\fP Reference in which to return the number of blacklisted devices
.RE
.PP
\fBReturns:\fP
.RS 4
.IP "\(bu" 2
\fBNVML_SUCCESS\fP if \fIdeviceCount\fP has been set
.IP "\(bu" 2
\fBNVML_ERROR_INVALID_ARGUMENT\fP if \fIdeviceCount\fP is NULL 
.PP
.RE
.PP

.SS "\fBnvmlReturn_t\fP DECLDIR nvmlGetBlacklistDeviceInfoByIndex (unsigned int index, \fBnvmlBlacklistDeviceInfo_t\fP * info)"
.PP
Acquire the device information for a blacklisted device, based on its index.
.PP
For all products.
.PP
Valid indices are derived from the \fIdeviceCount\fP returned by \fBnvmlGetBlacklistDeviceCount()\fP. For example, if \fIdeviceCount\fP is 2 the valid indices are 0 and 1, corresponding to GPU 0 and GPU 1.
.PP
\fBParameters:\fP
.RS 4
\fIindex\fP The index of the target GPU, >= 0 and < \fIdeviceCount\fP 
.br
\fIinfo\fP Reference in which to return the device information
.RE
.PP
\fBReturns:\fP
.RS 4
.IP "\(bu" 2
\fBNVML_SUCCESS\fP if \fIdevice\fP has been set
.IP "\(bu" 2
\fBNVML_ERROR_INVALID_ARGUMENT\fP if \fIindex\fP is invalid or \fIinfo\fP is NULL
.PP
.RE
.PP
\fBSee also:\fP
.RS 4
\fBnvmlGetBlacklistDeviceCount\fP 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for NVML from the source code.