SetWindowContextHelpId

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
No
Import Library
user32.lib
Header File
winuser.h
Unicode
No
Platform Notes
None

The SetWindowContextHelpId function associates a help context identifier with the specified window.

BOOL SetWindowContextHelpId(

HWND hwnd,
DWORD dwContextHelpId
);

Parameters
hwnd
Handle to the window with which to associate the help context identifier.

dwContextHelpId
Help context identifier.

Return Values
If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Remarks
If a child window does not have a help context identifier, it inherits the identifier of its parent window. Likewise, if an owned window does not have a help context identifier, it inherits the identifier of its owner window. This inheritance of help context identifiers allows an application to set just one identifier for a dialog box and all of its controls.