PropVariantToInt32WithDefault-Funktion (propvarutil.h)

  • Artikel

Extrahiert einen Int32-Wert aus einer PROPVARIANT-Struktur . Wenn derzeit kein Wert vorhanden ist, wird der angegebene Standardwert zurückgegeben.

Syntax

PSSTDAPI_(LONG) PropVariantToInt32WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] LONG           lDefault
);

Parameter

[in] propvarIn

Typ: REFPROPVARIANT

Verweis auf eine PROPVARIANT-Quellstruktur .

[in] lDefault

Typ: LONG

Gibt einen Standardwert für Die Verwendung an, wenn derzeit kein Wert vorhanden ist.

Rückgabewert

Typ: LONG

Gibt den extrahierten LONG-Wert oder den Standardwert zurück.

Hinweise

Diese Hilfsfunktion wird an Stellen verwendet, an denen die aufrufende Anwendung erwartet, dass eine PROPVARIANT einen LONG-Wert enthält und andernfalls einen Standardwert verwenden möchte. Für instance kann eine Anwendung, die Werte aus einem Eigenschaftenspeicher bezieht, dies verwenden, um den LONG-Wert für Int32-Eigenschaften sicher zu extrahieren.

Wenn die Propvariant-Quelleden Typ VT_I4 hat, extrahiert diese Hilfsfunktion den LONG-Wert . Andernfalls wird versucht, den Wert in der PROPVARIANT-Struktur in einen LONG-Wert zu konvertieren. Wenn die Propvariant-Quelleden Typ VT_EMPTY hat oder eine Konvertierung nicht möglich ist, gibt PropVariantToInt32WithDefault den von lDefault bereitgestellten Standardwert zurück. Eine Liste möglicher Konvertierungen finden Sie unter PropVariantChangeType .

Beispiele

Im folgenden Beispiel, das als Teil eines größeren Programms eingeschlossen werden soll, wird veranschaulicht, wie PropVariantToInt32WithDefault verwendet wird, um auf einen LONG-Wert in einer PROPVARIANT zuzugreifen.

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_FlagStatus, &propvar);
if (SUCCEEDED(hr))
{
     // PKEY_FlagStatus is expected to produce a VT_I4 or VT_EMPTY value.
     // The application developer decided to treat VT_EMPTY or invalid values as 0
     LONG iStatus = PropVariantToInt32WithDefault(propvar, 0);
     // iStatus is now valid.
     PropVariantClear(&propvar);
}

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows XP mit SP2, Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 mit SP1 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile propvarutil.h
Bibliothek Propsys.lib
DLL Propsys.dll (Version 6.0 oder höher)
Verteilbare Komponente Windows Desktop Search (WDS) 3.0

Weitere Informationen

InitPropVariantFromInt32

PropVariantChangeType

PropVariantToInt32

VariantToInt32