IHelp.GetHelpInfo(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Int32

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

Share via