共用方式為

PropVariantToBooleanWithDefault 函式 (propvarutil.h)

  • 發行項

擷取 PROPVARIANT 結構的布爾屬性值。 如果沒有值存在，則會傳回指定的預設值。

語法

PSSTDAPI_(BOOL) PropVariantToBooleanWithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] BOOL           fDefault
);

參數

[in] propvarIn

類型： REFPROPVARIANT

來源 PROPVARIANT 結構的參考。

[in] fDefault

類型： BOOL

指定預設屬性值，用於目前沒有任何值存在的位置。

傳回值

類型： BOOL

擷取的布爾值或預設值。

備註

此協助程式函式用於呼叫端應用程式預期 PROPVARIANT 保留布爾值的位置，而且如果不是，則會使用預設值。 例如，從屬性存放區取得值的應用程式可以使用這個來安全地擷取布爾值的布爾值。

如果來源 PROPVARIANT 的類型 VT_BOOL，這個協助程式函式會擷取布爾值。 否則，它會嘗試將 PROPVARIANT 結構中的值轉換成布爾值。 如果來源 PROPVARIANT 有類型VT_EMPTY或無法轉換，則 PropVariantToBooleanWithDefault 會傳回 fDefault 所提供的預設值。 如需可能轉換的清單 ，請參閱 PropVariantChangeType 。

範例

下列範例要包含在較大的程式中，示範如何使用 PropVariantToBooleanWithDefault 來存取 PROPVARIANT 中的布爾值。

// IPropertyStore *ppropstore;
// Assume the variable ppropstore is initialized and valid.
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_IsRead, &propvar);

if (SUCCEEDED(hr))
{
     // PKEY_IsRead is expected to produce a VT_BOOL or VT_EMPTY value.
     // The application developer decided to treat VT_EMPTY or invalid values as TRUE
     BOOL fShared = PropVariantToBooleanWithDefault(propvar, TRUE);
     
     // fShared is now valid.
     PropVariantClear(&propvar);
}

規格需求

需求 值
最低支援的用戶端 Windows XP 搭配 SP2、Windows Vista [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2003 SP1 [僅限傳統型應用程式]
目標平台 Windows
標頭 propvarutil.h
程式庫 Propsys.lib
Dll Propsys.dll (6.0 版或更新版本)
可轉散發套件 Windows 桌面搜尋 (WDS) 3.0