QueryIoRateControlInformationJobObject function (jobapi2.h)

Article
02/22/2024

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

Syntax

DWORD QueryIoRateControlInformationJobObject(
  [in, optional] HANDLE                                hJob,
  [in, optional] PCWSTR                                VolumeName,
  [out]          JOBOBJECT_IO_RATE_CONTROL_INFORMATION **InfoBlocks,
  [out]          ULONG                                 *InfoBlockCount
);

Parameters

[in, optional] hJob

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.

[in, optional] VolumeName

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.

[out] InfoBlocks

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.

[out] InfoBlockCount

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

Return value

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.

Requirements

Requirement	Value
Minimum supported client	Windows 10 [desktop apps only]
Minimum supported server	Windows Server 2016 [desktop apps only]
Target Platform	Windows
Header	jobapi2.h
Library	Kernel32.lib
DLL	Kernel32.dll