InitializeProcessForWsWatch function (Windows)

Switch View :
ScriptFree
InitializeProcessForWsWatch function

Applies to: desktop apps only

Initiates monitoring of the working set of the specified process. You must call this function before calling the GetWsChanges function.

Syntax

BOOL WINAPI InitializeProcessForWsWatch(
  __in  HANDLE hProcess
);

Parameters

hProcess [in]

A handle to the process. The handle must have the PROCESS_QUERY_INFORMATION access right. For more information, see Process Security and Access Rights.

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

Starting with Windows 7 and Windows Server 2008 R2, Psapi.h establishes version numbers for the PSAPI functions. The PSAPI version number affects the name used to call the function and the library that a program must load.

If PSAPI_VERSION is 2 or greater, this function is defined as K32InitializeProcessForWsWatch in Psapi.h and exported in Kernel32.lib and Kernel32.dll. If PSAPI_VERSION is 1, this function is defined as InitializeProcessForWsWatch in Psapi.h and exported in Psapi.lib and Psapi.dll as a wrapper that calls K32InitializeProcessForWsWatch.

Programs that must run on earlier versions of Windows as well as Windows 7 and later versions should always call this function as InitializeProcessForWsWatch. To ensure correct resolution of symbols, add Psapi.lib to the TARGETLIBS macro and compile the program with -DPSAPI_VERSION=1. To use run-time dynamic linking, load Psapi.dll.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

Psapi.h

Library

Kernel32.lib on Windows 7 and Windows Server 2008 R2;
Psapi.lib (if PSAPI_VERSION=1) on Windows 7 and Windows Server 2008 R2;
Psapi.lib on Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP

DLL

Kernel32.dll on Windows 7 and Windows Server 2008 R2;
Psapi.dll (if PSAPI_VERSION=1) on Windows 7 and Windows Server 2008 R2;
Psapi.dll on Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP

See also

EnumProcesses
GetWsChanges
PSAPI Functions
Working Set Information

 

 

Send comments about this topic to Microsoft

Build date: 2/7/2012

Community Content

Geoff Darst - MSFT
Documentation Incomplete

In addition to PROCESS_QUERY_INFORMATION, the process must also be opened with
PROCESS_SET_INFORMATION access rights.