This topic has not yet been rated - Rate this topic

SetWindowContextHelpId function

Applies to: desktop apps only

Associates a Help context identifier with the specified window.

Syntax

BOOL SetWindowContextHelpId(
  HWND hwnd,
  DWORD dwContextHelpId
);

Parameters

hwnd

Type: HWND

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

dwContextHelpId

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

Minimum supported client

Windows XP

Minimum supported server

Windows 2000 Server

Header

Winuser.h

Library

User32.lib

DLL

User32.dll

See also

GetWindowContextHelpId

 

 

Send comments about this topic to Microsoft

Build date: 3/7/2012

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ