IHelp.GetHelpInfo Method
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)
Syntax
'Declaration
Function GetHelpInfo ( _
<OutAttribute> ByRef pdwHelpInfo As UInteger _
) As Integer
int GetHelpInfo(
out uint pdwHelpInfo
)
int GetHelpInfo(
[OutAttribute] unsigned int% pdwHelpInfo
)
abstract GetHelpInfo :
pdwHelpInfo:uint32 byref -> int
function GetHelpInfo(
pdwHelpInfo : uint
) : int
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.
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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.