Edit

Share via


SetWindowContextHelpId function (winuser.h)

Associates a Help context identifier with the specified window.

Syntax

BOOL SetWindowContextHelpId(
  HWND  unnamedParam1,
  DWORD unnamedParam2
);

Parameters

unnamedParam1

Type: HWND

A handle to the window with which to associate the Help context identifier.

unnamedParam2

Type: DWORD

The Help context identifier.

Return value

Type: BOOL

Returns nonzero if successful, or zero otherwise.

To retrieve extended error information, call GetLastError.

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.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winuser.h
Library User32.lib
DLL User32.dll

See also

GetWindowContextHelpId