IPropertyPage::Help-Methode (ocidl.h)

  • Artikel

Ruft die Eigenschaftenseite als Antwort auf eine Endbenutzeranforderung auf.

Syntax

HRESULT Help(
  [in] LPCOLESTR pszHelpDir
);

Parameter

[in] pszHelpDir

Ein Zeiger auf die Zeichenfolge unter dem HelpDir-Schlüssel in den CLSID-Informationen der Eigenschaftenseite in der Registrierung. Wenn HelpDir nicht vorhanden ist, ist dies der Pfad, der im Eintrag InprocServer32 abzüglich des Serverdateinamens gefunden wird. (Beachten Sie, dass LocalServer32 nicht aktiviert ist, da lokale Eigenschaftenseiten nicht unterstützt werden.)

Rückgabewert

Diese Methode kann die Standardrückgabewerte E_OUTOFMEMORY und E_UNEXPECTED sowie die folgenden Werte zurückgeben.

Rückgabecode BESCHREIBUNG
S_OK
 Die Seite hat eine eigene Hilfe angezeigt.
E_NOTIMPL
 Hilfe wird entweder nicht bereitgestellt oder nur über die Informationen proppageinfo bereitgestellt.

Hinweise

Hinweise für Anrufer

Aufrufe dieser Methode müssen zwischen Aufrufen von IPropertyPage::Activate und IPropertyPage::D eactivate erfolgen.

Hinweise zu Implementierern

Wenn die Seite mit dieser Methode fehlschlägt (z. B. E_NOTIMPL), versucht der Frame, die Elemente pszHelpFile und dwHelpContext der über IPropertyPage::GetPageInfo abgerufenen PROPPAGEINFO-Struktur zu verwenden. Daher sollte die Seite entweder IPropertyPage::Help implementieren oder Hilfeinformationen über IPropertyPage::GetPageInfo zurückgeben.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile ocidl.h

Weitere Informationen

IPropertyPage

PROPPAGEINFO