PropVariantToInt32VectorAlloc 関数 (propvarutil.h)

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

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

構文

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

パラメーター

[in] propvar

型: REFPROPVARIANT

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

[out] pprgn

種類: LONG**

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

[out] pcElem

種類: ULONG*

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

戻り値

種類: HRESULT

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

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

注釈

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

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

例

より大きなプログラムの一部として含める次の例では、PropVariantToInt32VectorAlloc を使用して PROPVARIANT 内の LONG ベクター値にアクセスする方法を示します。

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

要件

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