PropVariantToBooleanVector 関数 (propvarutil.h)

PROPVARIANT 構造体からブール型ベクトルを抽出します。

構文

PSSTDAPI PropVariantToBooleanVector(
  [in]  REFPROPVARIANT propvar,
  [out] BOOL           *prgf,
  [in]  ULONG          crgf,
  [out] ULONG          *pcElem
);

パラメーター

[in] propvar

型: REFPROPVARIANT

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

[out] prgf

種類: BOOL*

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

[in] crgf

種類: ULONG

prgf によって指されるバッファー内の要素の数。

[out] pcElem

種類: ULONG*

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

戻り値

種類: HRESULT

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

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

解説

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

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

例

大規模なプログラムの一部として含める次の例では、 PropVariantToBooleanVector を使用して PROPVARIANT に格納されているブール型ベクトルにアクセスする方法を示します。

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid.

// The application is expecting the propvar variable to hold 4 Booleans
// in a vector.
BOOL rgFlags[4]; 
ULONG cFlags;
HRESULT hr = PropVariantToBooleanVector(propvar, rgFlags, ARRAYSIZE(rgFlags), &cFlags);

if (SUCCEEDED(hr))
{
     if (cFlags == ARRAYSIZE(rgFlags))
     {
         // The application received 4 flags which are now stored in rgFlags.
     }
     else
     {
         // The application received cFlags flags which are now stored in the 
         // first cFlags elements of rgFlags.
     }
}

要件

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