PropVariantToUInt32Vector 関数 (propvarutil.h)

[アーティクル]
08/25/2023

PROPVARIANT 構造体から ULONG ベクターにデータを抽出します。

構文

PSSTDAPI PropVariantToUInt32Vector(
  [in]  REFPROPVARIANT propvar,
  [out] ULONG          *prgn,
  [in]  ULONG          crgn,
  [out] ULONG          *pcElem
);

パラメーター

[in] propvar

型: REFPROPVARIANT

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

[out] prgn

種類: ULONG*

crgnULONG 値を含むバッファーを指します。この関数が戻ると、バッファーは、ソース PROPVARIANT から抽出された pcElemULONG 要素で初期化されています。

[in] crgn

種類: ULONG

prgn が指すバッファーのサイズ (要素単位)。

[out] pcElem

種類: ULONG*

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

戻り値

種類: HRESULT

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

リターンコード	説明
S_OK	成功した場合はS_OK を返し、それ以外の場合はエラー値を返します。
TYPE_E_BUFFERTOOSMALL	ソース PROPVARIANT には crgn 値を超える値が含まれていました。 prgn が指すバッファーが小さすぎます。
E_INVALIDARG	PROPVARIANT が適切な型ではありません。

注釈

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

ソース PROPVARIANT の型が VT_UI4 または VT_ARRAY | VT_UI4 VT_VECTOR | 場合、このヘルパー関数は最大 crgnULONG 値を抽出し、prgn が指すバッファーに配置します。 PROPVARIANT に prgn バッファーに収まるより多くの要素が含まれている場合、この関数はエラーを返し、pcElem を 0 に設定します。

例

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

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid
ULONG rgLongs[4]; // The application is expecting propvar to hold 4 ULONGs in a vector
ULONG cElems;
HRESULT hr = PropVariantToUInt32Vector(propvar, rgLongs, ARRAYSIZE(rgLongs), &cElems);
if (SUCCEEDED(hr))
{
     if (cElems == ARRAYSIZE(rgLongs))
     {
         // The application got 4 ULONGs which are now stored in rgLongs
     }
     else
     {
         // The application got cElems which are stored in the first cElems elements of rgLongs
     }
}

要件

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