VariantToBooleanArray 関数 (propvarutil.h)

[アーティクル]
08/08/2024

VARIANT 構造体からブール値の配列を抽出します。

構文

PSSTDAPI VariantToBooleanArray(
  [in]  REFVARIANT var,
  [out] BOOL       *prgf,
  [in]  ULONG      crgn,
  [out] ULONG      *pcElem
);

パラメーター

[in] var

型: REFVARIANT

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

[out] prgf

種類: BOOL*

crgn ブール値を含むバッファーへのポインター。この関数が戻ると、バッファーはソース VARIANT 構造体から抽出された *pcElemBOOL 要素で初期化されています。

[in] crgn

種類: ULONG

prgf が指すバッファー内の要素の数。

[out] pcElem

種類: ULONG*

この関数が戻るときに、には、ソース VARIANT 構造体から抽出された BOOL 要素の数へのポインターが含まれます。

戻り値

型: HRESULT

成功 した場合はS_OK を返し、それ以外の場合は次のようなエラー値を返します。

リターンコード	説明
TYPE_E_BUFFERTOOSMALL	ソース VARIANT に crgn 値を超える値が含まれていました。
E_INVALIDARG	VARIANT が適切な型ではありません。

注釈

このヘルパー関数は、呼び出し元のアプリケーションが、固定数のブール値で構成される配列を保持する VARIANT を想定している場合に使用されます。

ソース VARIANT の型が VT_ARRAY |VT_BOOL、この関数は最大 crgnBOOL 値を抽出し、 prgf が指すバッファーに配置します。 VARIANT に含まれる要素が prgf バッファーに収まらない場合、この関数はエラーを返し、*pcElem を 0 に設定します。

例

次の例は、より大きなプログラムの一部として含めるために、VariantToBooleanArray を使用して、VARIANT 構造体に格納されている BOOL 値の配列にアクセスする方法を示しています。

// VARIANT var;
// Assume variable var is initialized and valid
BOOL rgFlags[4]; // The application is expecting var to hold 4 BOOLs in an array.
ULONG cFlags;

HRESULT hr = VariantToBooleanArray(var, rgFlags, ARRAYSIZE(rgFlags), &cFlags);

if (SUCCEEDED(hr))
{
    if (cFlags == ARRAYSIZE(rgFlags))
    {
        // The application got 4 flag values which are now stored in rgFlags.
    }
    else
    {
        // The application got cFlags which are 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