PropVariantToInt16VectorAlloc-Funktion (propvarutil.h)

Artikel
03/06/2024

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

Syntax

PSSTDAPI PropVariantToInt16VectorAlloc(
  [in]  REFPROPVARIANT propvar,
  [out] SHORT          **pprgn,
  [out] ULONG          *pcElem
);

Parameter

[in] propvar

Typ: REFPROPVARIANT

Verweis auf eine PROPVARIANT-Quellstruktur .

[out] pprgn

Typ: SHORT**

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

[out] pcElem

Typ: ULONG*

Wenn diese Funktion zurückgibt, enthält die Anzahl der Int16-Elemente , die aus der Quellstruktur PROPVARIANT 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 entsprechenden Typ.

Hinweise

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

Wenn die Quelle PROPVARIANT den Typ VT_VECTOR | VT_I2 oder VT_ARRAY | VT_I2 extrahiert diese Funktion einen Vektor von Int16-Werten in einen neu zugeordneten Vektor von SHORT-Werten. Die aufrufende Anwendung ist für die Verwendung von CoTaskMemFree verantwortlich, um den von pprgn angezeigten Vektor freizugeben, wenn er nicht mehr benötigt wird.

Beispiele

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

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

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