IOleInPlaceComponent.GetCntrHelp – metoda (UInt32, Guid, POINT, UInt32, String, String, UInt32, UInt32)

Článek
08/05/2016

Umožňuje VSPackage objekt v místě za předpokladu, že hlavní součást role přepsání objektu rolí podsoučásti nebo součást řízení za předpokladu, že požadované téma nápovědy.

Obor názvů: Microsoft.VisualStudio.Shell.Interop
Sestavení: Microsoft.VisualStudio.Shell.Interop (v Microsoft.VisualStudio.Shell.Interop.dll)

Syntaxe

int GetCntrHelp(
    ref uint pdwRole,
    ref Guid pclsid,
    POINT posMouse,
    uint dwHelpCmd,
    string pszHelpFileIn,
    out string ppszHelpFileOut,
    uint dwDataIn,
    out uint pdwDataOut
)

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

abstract GetCntrHelp : 
        pdwRole:uint32 byref *
        pclsid:Guid byref *
        posMouse:POINT *
        dwHelpCmd:uint32 *
        pszHelpFileIn:string *
        ppszHelpFileOut:string byref *
        dwDataIn:uint32 *
        pdwDataOut:uint32 byref -> int

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

Parametry

pdwRole
[v][výstup] Na vstupu, ukazatel na roli objektu v místě, požadující téma nápovědy.Na výstupu ukazatel na roli v místě objektu, který je odpovědný za zobrazení tématu nápovědy.Seznam platných pdwRole hodnoty, viz OLEROLE.

pclsid
[v][výstup] Na vstupu, ukazatel na identifikátor třídy objektu v místě požadující téma nápovědy.Na výstupu ukazatel na identifikátor třídy objektu v místě za zobrazení tématu nápovědy.

posMouse
[v] Určuje pozici myší.Pozice myši může být užitečné pro režimy uživatelské rozhraní, které chcete zobrazit nápovědu pro prvek uživatelského rozhraní namísto spuštění příkazu přidružené k prvku.

dwHelpCmd
[v] Určuje zobrazení tématu nápovědy.

pszHelpFileIn
[v] Ukazatel na soubor nápovědy k zobrazení.

ppszHelpFileOut
[výstup] Ukazatel na soubor nápovědy, který byl zobrazen.

dwDataIn
[v] Určuje data nápovědy k zobrazení.

pdwDataOut
[výstup] Ukazatel na data nápovědy, který byl zobrazen.

Vrácená hodnota

Type: System.Int32

Pokud metoda uspěje, vrací S_OK.Pokud se nezdaří, vrátí kód chyby.

Poznámky

Podpis COM

Z 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
);

Objekt VSPackage v místě působí jako hlavní součást přepsat kontextu souboru nebo nápovědy Nápověda podsoučásti nebo součást řízení přímo v objektu.

Prostředí je odpovědná za uvolňování parametry řetězce OUT pomocí aktivní přidělování OLE IMalloc.

Obvykle vrátit většinu objektů v místě S_OK z této metody.

Viz také

IOleInPlaceComponent – rozhraní
Microsoft.VisualStudio.Shell.Interop – obor názvů

Zpátky na začátek

Sdílet prostřednictvím