IPerPropertyBrowsing::GetPredefinedValue-Methode (ocidl.h)

Artikel
08/25/2023

Ruft den Wert der angegebenen Eigenschaft ab, die einem vordefinierten Zeichenfolgennamen zugeordnet ist. Diese Eigenschaft ist einem vordefinierten Zeichenfolgennamen zugeordnet, der von IPerPropertyBrowsing::GetPredefinedStrings zurückgegeben wird. Die vordefinierte Zeichenfolge wird durch ein Token identifiziert, das von GetPredefinedStrings zurückgegeben wird.

Syntax

HRESULT GetPredefinedValue(
  [in]  DISPID  dispID,
  [in]  DWORD   dwCookie,
  [out] VARIANT *pVarOut
);

Parameter

[in] dispID

Der Dispatchbezeichner der Eigenschaft, für die ein vordefinierter Wert angefordert wird.

[in] dwCookie

Ein Token, das den zurückzugebenden Wert angibt. Das Token wurde zuvor im pCaCookiesOut-Array zurückgegeben, das von GetPredefinedStrings gefüllt wurde.

[out] pVarOut

Ein Zeiger auf den VARIANT-Wert für die Eigenschaft.

Rückgabewert

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

Rückgabecode	BESCHREIBUNG
S_OK	Die Methode wurde erfolgreich abgeschlossen.
E_NOTIMPL	Dieses Objekt unterstützt keine vordefinierten Zeichenfolgen oder vordefinierten Werte.
E_POINTER	Die Adresse in pVarOut ist ungültig. Es kann z. B. NULL sein.

Hinweise

Hinweise für Anrufer

Der Aufrufer ist dafür verantwortlich, alle im VARIANT enthaltenen Zuordnungen frei zu geben. Sofern der vt-Member von VARIANT nicht VT_VARIANT ist, kann der Aufrufer Arbeitsspeicher mithilfe eines einzelnen Aufrufs von VariantClear freigeben. Andernfalls muss der Aufrufer die enthaltenen VARIANT-Werte rekursiv freigeben, bevor er den äußeren VARIANT-Wert freigibt.

Hinweise für Implementierer

Die Unterstützung für vordefinierte Namen und Werte ist nicht erforderlich. Wenn Ihr Objekt diese Namen nicht unterstützt, geben Sie E_NOTIMPL von dieser Methode zurück. Wenn diese Methode nicht implementiert ist, darf IPerPropertyBrowsing::GetPredefinedStrings auch nicht implementiert werden.

Diese Methode ordnet den in VARIANT benötigten Arbeitsspeicher zu.

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

IPerPropertyBrowsing

Share via