SetIoRateControlInformationJobObject function (jobapi2.h)

Article
10/13/2021

Sets I/O limits on a job object.

Syntax

DWORD SetIoRateControlInformationJobObject(
  [in] HANDLE                                hJob,
  [in] JOBOBJECT_IO_RATE_CONTROL_INFORMATION *IoRateControlInfo
);

Parameters

[in] hJob

A handle to the job on which to set I/O limits. Get this handle from the CreateJobObject or OpenJobObject function. The handle must have the JOB_OBJECT_SET_ATTRIBUTES access right. For more information about access rights, see Job Object Security and Access Rights.

[in] IoRateControlInfo

A pointer to a JOBOBJECT_IO_RATE_CONTROL_INFORMATION structure that specifies the I/O limits to set for the job.

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