IOleInPlaceComponent.GetCntrHelp Yöntem (UInt32, Guid, POINT, UInt32, String, String, UInt32, UInt32)

Makale
08/08/2016

Bir alt bileşen veya bileşen denetim rolüne varsayılarak bir nesne tarafından istenen Yardım konusu geçersiz kılmak için ana bileşen rolü varsayılarak bir yerinde VSPackage nesne sağlar.

Ad Alanı: Microsoft.VisualStudio.Shell.Interop
Derleme: Microsoft.VisualStudio.Shell.Interop (Microsoft.VisualStudio.Shell.Interop.dll içinde)

Sözdizimi

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

Parametreler

pdwRole
Type: System.UInt32

[in] [out] Yardım konusu isteyen yerinde nesne rolü giriş, işaretçi üzerinde. Çıkışta rolüne Yardım konusunu görüntülemek için sorumlu yerinde nesnesinin işaretçisi. Geçerli bir listesi için pdwRole değerler, bakın OLEROLE.

pclsid
Type: System.Guid

[in] [out] Yardım konusunun isteyen yerinde nesnenin sınıf tanımlayıcısı giriş, işaretçi üzerinde. Çıkışta Yardım konusunu görüntülemek için sorumlu yerinde nesnenin sınıf tanımlayıcısı işaretçisi.

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

[in] Fare konumu belirtir. Fare konumu bu öğeyle ilişkili komutu yürütmek yerine bir kullanıcı arabirimi öğesi için Yardım görüntülemek kullanıcı arabirim modları için yararlı olabilir.

dwHelpCmd
Type: System.UInt32

[in] Görüntülenecek Yardım konusunu belirtir.

pszHelpFileIn
Type: System.String

[in] Görüntülenecek bir Yardım dosyası işaretçisi.

ppszHelpFileOut
Type: System.String

[out] Görüntülenen Yardım dosyasını işaretçisi.

dwDataIn
Type: System.UInt32

[in] Verilerini görüntülemek için Yardım belirtir.

pdwDataOut
Type: System.UInt32

[out] Görüntülenen Yardım veri işaretçisi.

Dönüş Değeri

Type: System.Int32

Yöntem başarılı olursa, döndürür S_OK. Başarısız olursa, bir hata kodu döndürür.

Notlar

COM imza

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

Ana bileşen olarak davranan bir yerinde VSPackage nesne bir alt bileşen veya bileşen denetim yerinde nesne Yardım dosyası ve/veya Yardım bağlamı geçersiz kılabilirsiniz.

Ortam etkin OLE IMalloc ayırıcıyı kullanarak çıkış dizesi parametreleri serbest bırakma için sorumludur.

Genellikle, çoğu yerinde nesneleri döndüren S_OK Bu yöntemden.

Ayrıca bkz.

IOleInPlaceComponent Arabirim
Microsoft.VisualStudio.Shell.Interop Ad Alanı

Başa dön

Aracılığıyla paylaş