SetProcessAffinityUpdateMode function

Sets the affinity update mode of the specified process.

Syntax


BOOL WINAPI SetProcessAffinityUpdateMode(
  _In_ HANDLE ProcessHandle,
  _In_ DWORD  dwFlags
);

Parameters

ProcessHandle [in]

A handle to the process. This handle must be returned by the GetCurrentProcess function.

dwFlags [in]

The affinity update mode. This parameter can be one of the following values.

ValueMeaning
0

Disables dynamic update of the process affinity by the system.

PROCESS_AFFINITY_ENABLE_AUTO_UPDATE
0x00000001UL

Enables dynamic update of the process affinity by the system.

 

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

The system can adjust process affinity under various conditions, such as when a processor is added dynamically. By default, dynamic updates to the process affinity are disabled for each process.

Processes should use this function to indicate whether they can handle dynamic adjustment of process affinity by the system. After a process enables affinity update mode, it can call this function to disable it. However, a process cannot enable affinity update mode after it has used this function to disable it.

Child processes do not inherit the affinity update mode of the parent process. The affinity update mode must be explicitly set for each child process.

To compile an application that calls this function, define _WIN32_WINNT as 0x0600 or later. For more information, see Using the Windows Headers.

Requirements

Minimum supported client

Windows Vista with SP1 [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

WinBase.h on Windows Vista, Windows 7, Windows Server 2008 and Windows Server 2008 R2 (include Windows.h);
Processthreadsapi.h on Windows 8 and Windows Server 2012

Library

Kernel32.lib

DLL

Kernel32.dll

See also

QueryProcessAffinityUpdateMode

 

 

Show: