PropVariantToUInt64WithDefault-Funktion (propvarutil.h)

Artikel
03/01/2024

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

Syntax

PSSTDAPI_(ULONGLONG) PropVariantToUInt64WithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] ULONGLONG      ullDefault
);

Parameter

[in] propvarIn

Typ: REFPROPVARIANT

Verweis auf eine PROPVARIANT-Quellstruktur .

[in] ullDefault

Typ: ULONGLONG

Gibt einen Standardeigenschaftswert für die Verwendung an, wenn derzeit kein Wert vorhanden ist.

Rückgabewert

Typ: ULONGLONG

Gibt den extrahierten LONGLONG-Wert ohne Vorzeichen oder einen Standardwert zurück.

Hinweise

Diese Hilfsfunktion wird an Stellen verwendet, an denen die aufrufende Anwendung erwartet, dass ein PROPVARIANT einen ULONGLONGLONG-Wert enthält, und wenn dies nicht der Fall ist, einen Standardwert verwenden möchte. Für instance kann eine Anwendung, die Werte aus einem Eigenschaftenspeicher erhält, dies verwenden, um den ULONGLONG-Wert für UInt64-Eigenschaften sicher zu extrahieren.

Wenn die Propvariant-Quelleden Typ VT_UI8 hat, extrahiert diese Hilfsfunktion den ULONGLONG-Wert . Andernfalls wird versucht, den Wert in der PROPVARIANT-Struktur in einen ULONGLONG-Wert zu konvertieren. Wenn der PropVARIANT-QuelltypVT_EMPTY hat oder eine Konvertierung nicht möglich ist, gibt PropVariantToUInt64WithDefault den von ullDefault bereitgestellten Standardwert zurück. Eine Liste der möglichen Konvertierungen finden Sie unter PropVariantChangeType .

Beispiele

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

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_Size, &propvar);
if (SUCCEEDED(hr))
{
     // PKEY_Size is expected to produce a VT_UI8 or VT_EMPTY value.
     // The application developer decided to treat VT_EMPTY or invalid values as 0
     ULONGLONG ullSize = PropVariantToUInt64WithDefault(propvar, 0);
     // ullSize 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

Freigeben über