IOleInPlaceComponent.GetCntrHelp Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

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.

public:
 int GetCntrHelp([Runtime::InteropServices::Out] System::UInt32 % pdwRole, [Runtime::InteropServices::Out] Guid % pclsid, Microsoft::VisualStudio::OLE::Interop::POINT posMouse, System::UInt32 dwHelpCmd, System::String ^ pszHelpFileIn, [Runtime::InteropServices::Out] System::String ^ % ppszHelpFileOut, System::UInt32 dwDataIn, [Runtime::InteropServices::Out] System::UInt32 % pdwDataOut);

public int GetCntrHelp (out uint pdwRole, out Guid pclsid, Microsoft.VisualStudio.OLE.Interop.POINT posMouse, uint dwHelpCmd, string pszHelpFileIn, out string ppszHelpFileOut, uint dwDataIn, out uint pdwDataOut);

abstract member GetCntrHelp : uint32 * Guid * Microsoft.VisualStudio.OLE.Interop.POINT * uint32 * string * string * uint32 * uint32 -> int

Public Function GetCntrHelp (ByRef pdwRole As UInteger, ByRef pclsid As Guid, posMouse As POINT, dwHelpCmd As UInteger, pszHelpFileIn As String, ByRef ppszHelpFileOut As String, dwDataIn As UInteger, ByRef pdwDataOut As UInteger) As Integer

Parameters

pdwRole

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

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

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

UInt32

[in] Specifies the help topic to display.

pszHelpFileIn

String

[in] Pointer to a help file to display.

ppszHelpFileOut

String

[out] Pointer to the help file that was displayed.

dwDataIn

UInt32

[in] Specifies help data to display.

pdwDataOut

UInt32

[out] Pointer to the help data that was displayed.

Returns

Int32

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

Remarks

COM Signature

From oleipc.idl:

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.