PropVariantToInt32Vector 関数 (propvarutil.h)

PROPVARIANT 構造体から長い値のベクターを抽出します。

構文

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

パラメーター

[in] propvar

型: REFPROPVARIANT

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

[out] prgn

型: LONG*

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

[in] crgn

種類: ULONG

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

[out] pcElem

種類: ULONG*

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

戻り値

型: HRESULT

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

注釈

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

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

例

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

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

要件

こちらもご覧ください

InitPropVariantFromInt32Vector

PropVariantGetInt32Elem

PropVariantToInt32

PropVariantToInt32VectorAlloc

VariantToInt32Array