Share via


IHelp.GetHelpInfo(UInt32) Method

Definition

Gets information about the context of the help request.

public:
 int GetHelpInfo([Runtime::InteropServices::Out] System::UInt32 % pdwHelpInfo);
int GetHelpInfo([Runtime::InteropServices::Out] unsigned int & pdwHelpInfo);
public int GetHelpInfo (out uint pdwHelpInfo);
abstract member GetHelpInfo : uint32 -> int
Public Function GetHelpInfo (ByRef pdwHelpInfo As UInteger) As Integer

Parameters

pdwHelpInfo
UInt32

[out] A set of bit flags. Most commonly used to indicate whether or not "What's This" Help mode is active.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From objtext.idl:

HRESULT IHelp::GetHelpInfo(  
   [out] DWORD* pdwHelpInfo  
);  

Usage

To test for "What's This" Help mode, bit-and the parameter set by GetHelpInfo with the constant HELPINFO_WHATS_THIS_MODE_ON.

Applies to