IHelp::GetHelpInfo Method (UInt32)

 

Gets information about the context of the help request.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

int GetHelpInfo(
	[OutAttribute] unsigned int% pdwHelpInfo
)

Parameters

pdwHelpInfo
Type: System::UInt32

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

Return Value

Type: System::Int32

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

From objtext.idl:

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

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

Return to top
Show: