IOleInPlaceComponent::GetCntrHelp Method (UInt32, Guid, POINT, UInt32, String^, String^, UInt32, UInt32)

Visual Studio 2015

Allows an in-place VSPackage object assuming the main component role to override the help topic requested by an object assuming the subcomponent or component control role.

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

Syntax

C++

int GetCntrHelp(
	unsigned int% pdwRole,
	Guid% pclsid,
	POINT posMouse,
	unsigned int dwHelpCmd,
	String^ pszHelpFileIn,
	[OutAttribute] String^% ppszHelpFileOut,
	unsigned int dwDataIn,
	[OutAttribute] unsigned int% pdwDataOut
)

Parameters

pdwRole: Type: System::UInt32
[in][out] On input, pointer to the role of the in-place object requesting the help topic. On output, pointer to the role of the in-place object responsible for displaying the help topic. For a list of valid pdwRole values, see OLEROLE.

pclsid: Type: System::Guid
[in][out] On input, pointer to the class identifier of the in-place object requesting the help topic. On output, pointer to the class identifier of the in-place object responsible for displaying the help topic.

posMouse: Type: Microsoft.VisualStudio.OLE.Interop::POINT
[in] Specifies the position of the mouse. Mouse position can be useful for user interface modes that display help for a user interface element instead of executing the command associated with that element.

dwHelpCmd: Type: System::UInt32
[in] Specifies the help topic to display.

pszHelpFileIn: Type: System::String^
[in] Pointer to a help file to display.

ppszHelpFileOut: Type: System::String^
[out] Pointer to the help file that was displayed.

dwDataIn: Type: System::UInt32
[in] Specifies help data to display.

pdwDataOut: Type: System::UInt32
[out] Pointer to the help data that was displayed.

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 oleipc.idl:

C++

HRESULT IOleInPlaceComponent::GetCntrHelp(
   [in][out] DWORD *pdwRole,
   [in][out] CLSID *pclsid,
   [in] POINT posMouse,
   [in] DWORD dwHelpCmd,
   [in] LPOLESTR pszHelpFileIn,
   [out] LPOLESTR *ppszHelpFileOut,
   [in] DWORD dwDataIn,
   [out] DWORD *pdwDataOut
);

An in-place VSPackage object acting as a main component can override the help file and/or help context of a subcomponent or component control in-place object.

The environment is responsible for freeing the OUT string parameters using the active OLE IMalloc allocator.

Typically, most in-place objects return S_OK from this method.