PropVariantToInt16VectorAlloc 関数 (propvarutil.h)

[アーティクル]
03/01/2024

PROPVARIANT 構造体から新しく割り当てられた Int16 ベクターにデータを抽出します。

構文

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

パラメーター

[in] propvar

型: REFPROPVARIANT

ソース PROPVARIANT 構造体への参照。

[out] pprgn

種類: SHORT**

この関数が戻るときに、には、ソース PROPVARIANT 構造体から抽出された Int16 値のベクターへのポインターが含まれます。

[out] pcElem

種類: ULONG*

この関数が戻るときに、ソース PROPVARIANT 構造体から抽出された Int16 要素の数が格納されます。

戻り値

型: HRESULT

この関数は、これらの値のいずれかを返すことができます。

リターンコード	説明
S_OK	成功した場合はS_OK 、それ以外の場合はエラー値を返します。
E_INVALIDARG	PROPVARIANT が適切な型ではありません。

注釈

このヘルパー関数は、呼び出し元のアプリケーションが PROPVARIANT が Int16 ベクター値を保持することを想定している場所で使用されます。

ソース PROPVARIANT の型が VT_VECTOR の場合 |VT_I2またはVT_ARRAY |VT_I2、この関数は Int16 値のベクターを SHORT 値の新しく割り当てられたベクターに抽出します。呼び出し元のアプリケーションは、 CoTaskMemFree を使用して、不要になったときに pprgn が指すベクターを解放します。

例

このヘルパー関数は、呼び出し元のアプリケーションが PROPVARIANT が Int16 ベクター値を保持することを想定している場所で使用されます。

// 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);
}

要件

要件	値
サポートされている最小のクライアント	WINDOWS XP と SP2、Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2003 SP1 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	propvarutil.h
Library	Propsys.lib
[DLL]	Propsys.dll (バージョン 6.0 以降)
再頒布可能パッケージ	Windows デスクトップ検索 (WDS) 3.0