Método IOleComponentUIManager.ShowHelp (UInt32, Guid, POINT, UInt32, String, UInt32)

Artigo
08/09/2016

Publicado: agosto de 2016

Solicita a exibição de informações de Ajuda.

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

Sintaxe

int ShowHelp(
    uint dwCompRole,
    [InAttribute] ref Guid rclsidComp,
    POINT posMouse,
    uint dwHelpCmd,
    string pszHelpFile,
    uint dwData
)

int ShowHelp(
    unsigned int dwCompRole,
    [InAttribute] Guid% rclsidComp,
    POINT posMouse,
    unsigned int dwHelpCmd,
    String^ pszHelpFile,
    unsigned int dwData
)

abstract ShowHelp : 
        dwCompRole:uint32 *
        rclsidComp:Guid byref *
        posMouse:POINT *
        dwHelpCmd:uint32 *
        pszHelpFile:string *
        dwData:uint32 -> int

Function ShowHelp (
    dwCompRole As UInteger,
    <InAttribute> ByRef rclsidComp As Guid,
    posMouse As POINT,
    dwHelpCmd As UInteger,
    pszHelpFile As String,
    dwData As UInteger
) As Integer

Parâmetros

dwCompRole
Type: System.UInt32

[in] Função do objeto VSPackage solicitando a exibição de Ajuda. Para obter uma lista válida dwCompRole valores, consulte OLEROLE.

rclsidComp
Type: System.Guid

[in] Classe CLSID (identificador) do objeto VSPackage solicitando a exibição de Ajuda.

posMouse
Type: Microsoft.VisualStudio.OLE.Interop.POINT

[in] Identifica a posição do mouse.

dwHelpCmd
Type: System.UInt32

[in] Identifica o comando de ajuda a ser chamado.

pszHelpFile
Type: System.String

[in] Aponta para o caminho para o arquivo de ajuda a ser exibido.

dwData
Type: System.UInt32

[in] Dados específicos para o objeto de VSPackage.

Valor de retorno

Type: System.Int32

Se o método for bem-sucedido, ele retornará S_OK. Se ele falhar, ele retorna um código de erro.

Comentários

COM assinatura

De oleipc.idl:

HRESULT IOleComponentUIManager::ShowHelp(
   [in] DWORD dwCompRole,
   [in] REFCLSID rclsidComp,
   [in] POINT posMouse,
   [in] DWORD dwHelpCmd,
   [in] LPOLESTR pszHelpFile,
   [in] DWORD dwData
);

ShowHelp chama herdado SVsHelpService service. Os VSPackages pode acessar um serviço mais recente para obter ajuda chamando QueryService e solicitando SID_SVsHelp e IID_Help.

Exemplos

Consulte também

Interface IOleComponentUIManager
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Partilhar via