PropVariantToInt32VectorAlloc-Funktion (propvarutil.h)

Artikel
08/25/2023

Extrahiert Daten aus einer PROPVARIANT-Struktur in einen neu zugeordneten Int32-Vektor .

Syntax

PSSTDAPI PropVariantToInt32VectorAlloc(
  [in]  REFPROPVARIANT propvar,
  [out] LONG           **pprgn,
  [out] ULONG          *pcElem
);

Parameter

[in] propvar

Typ: REFPROPVARIANT

Verweis auf eine PROPVARIANT-Quellstruktur .

[out] pprgn

Typ: LONG**

Wenn diese Funktion zurückgibt, enthält einen Zeiger auf einen Vektor von LONG-Werten , die aus der PROPVARIANT-Quellstruktur extrahiert wurden.

[out] pcElem

Typ: ULONG*

Wenn diese Funktion zurückgibt, enthält die Anzahl der LONG-Elemente , die aus der PROPVARIANT-Quellstruktur extrahiert wurden.

Rückgabewert

Typ: HRESULT

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode	BESCHREIBUNG
S_OK	Gibt bei erfolgreicher Ausführung S_OK oder andernfalls einen Fehlerwert zurück.
E_INVALIDARG	PropVARIANT war nicht vom geeigneten Typ.

Hinweise

Diese Hilfsfunktion wird an Stellen verwendet, an denen die aufrufende Anwendung erwartet, dass eine PROPVARIANT einen Int32-Vektorwert enthält.

Wenn der Propvariant-QuelltypVT_VECTOR | VT_I4 oder VT_ARRAY | VT_I4 hat, extrahiert diese Funktion einen Vektor von LONG-Werten in einen neu zugeordneten Vektor. Die aufrufende Anwendung ist für die Verwendung von CoTaskMemFree verantwortlich, um den Vektor freizugeben, auf den pprgn verweist, wenn er nicht mehr benötigt wird.

Beispiele

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

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid. The application is expecting propvar to contain a vector of LONG values.
LONG *prgLongs;
ULONG cElems;
HRESULT hr = PropVariantToInt32VectorAlloc(propvar, &prgLongs, &cElems);
if (SUCCEEDED(hr))
{
     // prgLongs now points to a vector of cElems LONGs.
     CoTaskMemFree(prgLongs);
}

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