VariantToBooleanArrayAlloc 関数 (propvarutil.h)
BOOL 値の配列を割り当て、VARIANT 構造体からその配列にデータを抽出します。
構文
PSSTDAPI VariantToBooleanArrayAlloc(
[in] REFVARIANT var,
[out] BOOL **pprgf,
[out] ULONG *pcElem
);
パラメーター
[in] var
型: REFVARIANT
ソース VARIANT 構造体への参照。
[out] pprgf
種類: BOOL**
この関数が戻るときに、ソース VARIANT 構造体から抽出された BOOL 値の配列へのポインターが格納されます。
[out] pcElem
種類: ULONG*
この関数が戻るときに、 には、ソース VARIANT 構造体から抽出された要素の数へのポインターが含まれます。
戻り値
型: HRESULT
この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。
注釈
このヘルパー関数は、呼び出し元のアプリケーションが BOOL 値の配列を保持する VARIANT を想定している場合に使用されます。
ソース VARIANT の型が VT_ARRAY |VT_BOOL、この関数は BOOL 値の配列を新しく割り当てられた配列に抽出します。 呼び出し元のアプリケーションは 、CoTaskMemFree を使用して、不要になったときに pprgf が指す配列を解放します。
例
次の例は、より大きなプログラムの一部として含めるために、VariantToBooleanArrayAlloc を使用して、VARIANT 構造体に格納されている BOOL 値の配列にアクセスする方法を示しています。
// VARIANT var;
// Assume variable var is initialized and valid.
// The application expects var to contain an array of BOOL values.
BOOL *prgFlags;
ULONG cElems;
HRESULT hr = VariantToBooleanArrayAlloc(var, &prgFlags, &cElems);
if (SUCCEEDED(hr))
{
// prgFlags now points to a vector of cElems BOOLs.
CoTaskMemFree(prgFlags);
}
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | WINDOWS XP と SP2、Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2003 SP1 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | propvarutil.h |
| Library | Propsys.lib |
| [DLL] | Propsys.dll (バージョン 6.0 以降) |
| 再頒布可能パッケージ | Windows デスクトップ検索 (WDS) 3.0 |