Skip to content

Latest commit

 

History

History
99 lines (72 loc) · 4.1 KB

nf-jobapi2-queryioratecontrolinformationjobobject.md

File metadata and controls

99 lines (72 loc) · 4.1 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:jobapi2.QueryIoRateControlInformationJobObject
QueryIoRateControlInformationJobObject function (jobapi2.h)
Gets information about the control of the I/O rate for a job object.
QueryIoRateControlInformationJobObject
QueryIoRateControlInformationJobObject function
base.queryioratecontrolinformationjobobject
jobapi2/QueryIoRateControlInformationJobObject
base\queryioratecontrolinformationjobobject.htm
backup
B61DA8FC-1CF7-4D97-86F5-E3C2131D41EC
12/05/2018
QueryIoRateControlInformationJobObject, QueryIoRateControlInformationJobObject function, base.queryioratecontrolinformationjobobject, jobapi2/QueryIoRateControlInformationJobObject
jobapi2.h
Windows
Windows 10 [desktop apps only]
Windows Server 2016 [desktop apps only]
Kernel32.lib
Kernel32.dll
Windows
19H1
QueryIoRateControlInformationJobObject
jobapi2/QueryIoRateControlInformationJobObject
c++
APIRef
kbSyntax
DllExport
kernel32.dll
API-MS-Win-Core-Job-L2-1-1.dll
Kernel32Legacy.dll
QueryIoRateControlInformationJobObject

QueryIoRateControlInformationJobObject function

-description

Gets information about the control of the I/O rate for a job object.

-parameters

-param hJob [in, optional]

A handle to the job to query for information. Get this handle from the CreateJobObject or OpenJobObject function. The handle must have the JOB_OBJECT_QUERY access right. For more information about access rights, see Job Object Security and Access Rights.

If this value is NULL and the process that calls QueryIoRateControlInformationJobObject is associated with a job, the function uses job that is associated with the process. If the job is nested within another job, the function uses the immediate job for the process.

-param VolumeName [in, optional]

The name of the volume to query. If this value is NULL, the function gets the information about I/O rate control for the job for all of the volumes for the system.

-param InfoBlocks [out]

A pointer to array of JOBOBJECT_IO_RATE_CONTROL_INFORMATION structures that contain the information about I/O rate control for the job. Your code must free the memory for this array by calling the FreeMemoryJobObject function with the address of the array.

-param InfoBlockCount [out]

The number of JOBOBJECT_IO_RATE_CONTROL_INFORMATION structures that the function allocated in the array to which the InfoBlocks parameter points.

-returns

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

-remarks

Important  Starting with Windows 10, version 1607, this function is no longer supported.
 

-see-also

FreeMemoryJobObject

JOBOBJECT_IO_RATE_CONTROL_INFORMATION

SetIoRateControlInformationJobObject