Metoda IOleInPlaceComponent.GetCntrHelp — (UInt32, Guid, POINT, UInt32, String, String, UInt32, UInt32)
Umożliwia obiektu VSPackage w miejscu przy założeniu rolę głównego składnika do zastąpienia tematu pomocy żądany przez obiekt, zakładając, że rola kontroli podskładnika lub składnika.
Przestrzeń nazw: Microsoft.VisualStudio.Shell.Interop
Zestaw: Microsoft.VisualStudio.Shell.Interop (w Microsoft.VisualStudio.Shell.Interop.dll)
Składnia
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
Type: System.UInt32[in] [out] W danych wejściowych, wskaźnik do roli obiektu w miejscu żądanie tematu Pomocy. Produkcja, wskaźnik do roli obiektu w miejscu odpowiada za wyświetlanie tematu Pomocy. Nieprawidłowa lista pdwRole wartości, zobacz OLEROLE.
pclsid
Type: System.Guid[in] [out] W danych wejściowych, wskaźnik do identyfikatora klasy obiektu w miejscu żądanie tematu Pomocy. Produkcja, wskaźnik do identyfikatora klasy obiektu w miejscu odpowiada za wyświetlanie tematu Pomocy.
posMouse
Type: Microsoft.VisualStudio.OLE.Interop.POINT[in] Określa położenie kursora myszy. Położenie myszy może być przydatne w przypadku tryby interfejsu użytkownika, które wyświetla Pomoc dla elementu interfejsu użytkownika, ale nie wykonuje polecenia skojarzony z tym elementem.
dwHelpCmd
Type: System.UInt32[in] Określa temat pomocy do wyświetlenia.
pszHelpFileIn
Type: System.String[in] Wskaźnik do pliku pomocy do wyświetlenia.
ppszHelpFileOut
Type: System.String[out] Wskaźnik do pliku pomocy, który był wyświetlany.
dwDataIn
Type: System.UInt32[in] Określa pomoc danych do wyświetlenia.
pdwDataOut
Type: System.UInt32[out] Wskaźnik do wyświetlanych danych pomocy.
Wartość zwracana
Type: System.Int32
Jeśli metoda zakończy się pomyślnie, zwraca S_OK. Jeśli nie, zwraca kod błędu.
Uwagi
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
);
Obiekt pakietu VSPackage w miejscu działający jako główny składnik można zastąpić kontekstu plików i/lub pomocy pomocy obiektu w miejscu podskładnika lub składnik formantu.
Środowisko jest odpowiedzialny za zwalnianie poza parametrami przy użyciu active alokatora OLE IMalloc.
Zazwyczaj większość obiektów w miejscu zwrócić S_OK z tej metody.
Zobacz też
Interfejs IOleInPlaceComponent
Przestrzeń nazw Microsoft.VisualStudio.Shell.Interop
Powrót do początku