PropVariantToBoolean 関数 (propvarutil.h)

PROPVARIANT 構造体のブール型 (Boolean) のプロパティ値を抽出します。 値を抽出できない場合は、既定値が割り当てられます。

構文

PSSTDAPI PropVariantToBoolean(
  [in]  REFPROPVARIANT propvarIn,
  [out] BOOL           *pfRet
);

パラメーター

[in] propvarIn

型: REFPROPVARIANT

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

[out] pfRet

種類: BOOL*

この関数が戻るとき、 には抽出されたプロパティ値 (存在する場合) が格納されます。それ以外の場合は、 に FALSE が含まれます。

戻り値

種類: HRESULT

この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。

注釈

このヘルパー関数は、呼び出し元のアプリケーションが PROPVARIANT がブール値を保持することを想定している場所で使用されます。 たとえば、プロパティ ストアから値を取得するアプリケーションでは、これを使用して、ブール型プロパティのブール値を安全に抽出できます。

ソース PROPVARIANT に 型VT_BOOLがある場合、このヘルパー関数はブール値を抽出します。 それ以外の場合は、 PROPVARIANT 構造体の値をブール値に変換しようとします。 変換できない場合、 PropVariantToBoolean はエラー コードを返し、 pfRet を FALSE に設定 します。 可能な変換の一覧については、「 PropVariantChangeType 」を参照してください。 注意として、 VT_EMPTY は正常に FALSE に変換されます。

例

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

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};

HRESULT hr = ppropstore->GetValue(PKEY_IsShared, &propvar);
if (SUCCEEDED(hr))
{
     // PKEY_IsShared is expected to produce a VT_BOOL or VT_EMPTY value.
     // PropVariantToBoolean will convert VT_EMPTY to FALSE.
     BOOL fShared;
     
     hr = PropVariantToBoolean(propvar, &fShared);
     if (SUCCEEDED(hr))
     {
         // fShared is now valid
     }
     else
     {
         // fShared is always FALSE
     }
     
     PropVariantClear(&propvar);
}

                    

要件

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

こちらもご覧ください

InitPropVariantFromBoolean

PropVariantGetBooleanElem

PropVariantToBooleanWithDefault

VariantToBoolean