PropVariantToBooleanVectorAlloc 関数 (propvarutil.h)

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

構文

PSSTDAPI PropVariantToBooleanVectorAlloc(
  [in]  REFPROPVARIANT propvar,
  [out] BOOL           **pprgf,
  [out] ULONG          *pcElem
);

パラメーター

[in] propvar

型: REFPROPVARIANT

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

[out] pprgf

種類: BOOL**

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

[out] pcElem

種類: ULONG*

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

戻り値

型: HRESULT

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

解説

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

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

例

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

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid. The application is 
// expecting propvar to contain a vector of Boolean values.
BOOL *prgFlags;
ULONG cFlags;
HRESULT hr = PropVariantToBooleanVectorAlloc(propvar, &prgFlags, &cFlags);

if (SUCCEEDED(hr))
{
     // The prgFlags variable now points to a vector that contains a count
     // of cFlags flags.
     CoTaskMemFree(prgFlags);
}

要件

関連項目

InitPropVariantFromBooleanVector

IsPropVariantVector

PropVariantGetBooleanElem

PropVariantToBooleanVector