ICreateTypeInfo::SetFuncDocString-Methode (oaidl.h)

  • Artikel

Legt die Dokumentationszeichenfolge für die Funktion mit dem angegebenen Index fest.

Syntax

HRESULT SetFuncDocString(
  [in] UINT     index,
  [in] LPOLESTR szDocString
);

Parameter

[in] index

Der Index der Funktion.

[in] szDocString

Die Dokumentationszeichenfolge.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Rückgabecode Beschreibung
S_OK
Erfolg.
E_INVALIDARG
Mindestens eines der Argumente ist ungültig.
E_OUTOFMEMORY
Unzureichender Arbeitsspeicher, um den Vorgang abzuschließen.
E_ACCESSDENIED
 Das Ziel kann nicht geschrieben werden.
STG_E_INSUFFICIENTMEMORY
Unzureichender Arbeitsspeicher, um den Vorgang abzuschließen.
TYPE_E_ELEMENTNOTFOUND
 Das Element wurde nicht gefunden.

Hinweise

Die Dokumentationszeichenfolge ist eine kurze Beschreibung der Funktion, die für die Verwendung durch Tools wie Typbrowser vorgesehen ist. SetFuncDocString muss nur einmal für jede Eigenschaft verwendet werden, da alle Eigenschaftenzugriffsfunktionen mit einem Namen identifiziert werden.

Anforderungen

Anforderung Wert
Zielplattform Windows
Kopfzeile oaidl.h

Weitere Informationen

ICreateTypeInfo