VariantToBoolean 関数 (propvarutil.h)
VARIANT 構造体からブール型 (Boolean) プロパティの値を抽出します。 値を抽出できない場合は、既定値が割り当てられます。
構文
PSSTDAPI VariantToBoolean(
[in] REFVARIANT varIn,
[out] BOOL *pfRet
);
パラメーター
[in] varIn
型: REFVARIANT
ソース VARIANT 構造体への参照。
[out] pfRet
種類: BOOL*
この関数が戻るとき、抽出された値が存在する場合は を格納します。それ以外の場合は FALSE。
戻り値
種類: HRESULT
この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。
注釈
このヘルパー関数は、呼び出し元のアプリケーションで VARIANT がブール値を保持することを想定している場合に使用されます。 たとえば、シェル フォルダーから値を取得するアプリケーションでは、この関数を使用して、フォルダーのいずれかのブール型プロパティから値を安全に抽出できます。
ソース VARIANT が VT_BOOL 型の場合、この関数は BOOL 値を抽出します。
ソース VARIANT が型VT_BOOLでない場合、この関数は VARIANT 構造体の値を BOOL に変換しようとします。 変換できない場合、 VariantToBoolean はエラー コードを返し、 pfRet を FALSE に設定 します。 可能な変換の一覧については、「 PropVariantChangeType 」を参照してください。 メモとして、VT_EMPTYは FALSE に正常に変換されます。
例
大規模なプログラムの一部として含める次の例では、VariantToBoolean を使用して VARIANT の BOOL 値にアクセスする方法を示します。
// VARIANT var;
// Assume variable var is initialize and valid.
// The application expects it to hold a VT_BOOL value.
BOOL fValue;
HRESULT hr = VariantToBoolean(var, &fValue);
if (SUCCEEDED(hr))
{
// fValue is now valid.
}
else
{
// fValue is always FALSE.
}
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | WINDOWS XP と SP2、Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2003 SP1 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | propvarutil.h |
| Library | Propsys.lib |
| [DLL] | Propsys.dll (バージョン 6.0 以降) |
| 再頒布可能パッケージ | Windows デスクトップ検索 (WDS) 3.0 |