Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
SetHandleInformation
Collapse the table of content
Expand the table of content

SetHandleInformation function

Sets certain properties of an object handle.

Syntax


BOOL WINAPI SetHandleInformation(
  _In_ HANDLE hObject,
  _In_ DWORD  dwMask,
  _In_ DWORD  dwFlags
);

Parameters

hObject [in]

A handle to an object whose information is to be set.

You can specify a handle to one of the following types of objects: access token, console input buffer, console screen buffer, event, file, file mapping, job, mailslot, mutex, pipe, printer, process, registry key, semaphore, serial communication device, socket, thread, or waitable timer.

dwMask [in]

A mask that specifies the bit flags to be changed. Use the same constants shown in the description of dwFlags.

dwFlags [in]

Set of bit flags that specifies properties of the object handle. This parameter can be 0 or one or more of the following values.

ValueMeaning
HANDLE_FLAG_INHERIT
0x00000001

If this flag is set, a child process created with the bInheritHandles parameter of CreateProcess set to TRUE will inherit the object handle.

HANDLE_FLAG_PROTECT_FROM_CLOSE
0x00000002

If this flag is set, calling the CloseHandle function will not close the object handle.

 

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

To set or clear the associated bit flag in dwFlags, you must set a change mask bit flag in dwMask.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winbase.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

CreateProcess
CloseHandle
GetHandleInformation
Handle and Object Functions

 

 

Community Additions

ADD
Show:
© 2015 Microsoft