PropVariantToFileTime-Funktion (propvarutil.h)

Artikel
03/01/2024

Extrahiert die FILETIME-Struktur aus einer PROPVARIANT-Struktur .

Syntax

PSSTDAPI PropVariantToFileTime(
  [in]  REFPROPVARIANT propvar,
  [in]  PSTIME_FLAGS   pstfOut,
  [out] FILETIME       *pftOut
);

Parameter

[in] propvar

Typ: REFPROPVARIANT

Verweis auf eine PROPVARIANT-Quellstruktur .

[in] pstfOut

Typ: PSTIME_FLAGS

Gibt eines der folgenden Zeitflags an.

PSTF_UTC (0)

Gibt an, dass die Ausgabe koordinierte Universalzeit verwendet.

PSTF_LOCAL (1)

Gibt an, dass die Ausgabe die Ortszeit verwendet.

[out] pftOut

Typ: FILETIME*

Wenn diese Funktion zurückgibt, enthält die extrahierte FILETIME-Struktur .

Rückgabewert

Typ: HRESULT

Wenn diese Funktion erfolgreich ist, gibt sie S_OK zurück. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Diese Hilfsfunktion wird an Stellen verwendet, an denen die aufrufende Anwendung erwartet, dass ein PROPVARIANT einen einzelnen filetime-Wert enthält. Für instance kann eine Anwendung, die Werte aus einem Eigenschaftenspeicher bezieht, verwenden, um einen filetime-Wert für filetime-Eigenschaften sicher zu extrahieren.

Wenn die Propvariant-Quelle den Typ VT_FILETIME oder VT_DATE hat, extrahiert diese Hilfsfunktion den Wert als FILETIME unter Verwendung der von pstfOut angegebenen Zeitzone. Wenn die Propvariant-Quelle VT_EMPTY oder ein anderer Typ ist, gibt diese Funktion ein Fehlerergebnis zurück.

Die Propvariant-Quelle muss sich in koordinierter Weltzeit (UTC) befinden. Die PSTF_UTC- und PSTF_LOCAL-Flags ermöglichen es der aufrufenden Anwendung, anzugeben, in welche Zeitzone die Ausgabe konvertiert werden soll.

Beispiele

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

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_DateModified, &propvar);
if (SUCCEEDED(hr))
{
     // PKEY_DateModified is expected to produce a VT_FILETIME or VT_EMPTY value.
     // PropVariantToFileTime will return a failure code for VT_EMPTY
     FILETIME ftModified;
     hr = PropVariantToFileTime(propvar, PSTF_UTC, &ftModified);
     if (SUCCEEDED(hr))
     {
        // ftModified is now valid and contains a file time in UTC
     }
     else
     {
        // Unable to convert propvar to a FILETIME
     }
     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