VariantToBooleanWithDefault 函式 (propvarutil.h)
從 VARIANT 結構擷取 BOOL 值。 如果沒有值存在，則會傳回指定的預設值。
語法
PSSTDAPI_(BOOL) VariantToBooleanWithDefault(
[in] REFVARIANT varIn,
[in] BOOL fDefault
);
參數
[in] varIn
類型： REFVARIANT
來源 VARIANT 結構的參考。
[in] fDefault
類型： BOOL
未存在可擷取值的預設值。
傳回值
類型： BOOL
傳回擷取的 BOOL 值;否則為 fDefault 中指定的預設值。
備註
當呼叫端應用程式預期 VARIANT 保留 BOOL 值，而且如果不是的話，就會使用此協助程式函式。
如果來源 VARIANT 的類型為 VT_BOOL，則此協助程式會擷取 BOOL 值。
如果來源 VARIANT 不是類型VT_BOOL，函式會嘗試將 VARIANT 中的值轉換成 BOOL。
如果來源 VARIANT 的類型為 VT_EMPTY 或無法轉換，則 VariantToBooleanWithDefault 會傳回 fDefault 提供的預設值。 如需可能轉換的清單 ，請參閱 PropVariantChangeType 。
範例
下列範例要包含在較大的程式中，示範如何使用 VariantToBooleanWithDefault 來存取儲存在 VARIANT 結構中的 BOOL 值。
// VARIANT var;
// Assume variable var is initialized and valid.
// The application expects var to hold a BOOL value.
// The application treats VT_EMPTY as FALSE.
BOOL fValue = VariantToBooleanWithDefault(var, FALSE);
// fValue is now valid.
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | Windows XP 搭配 SP2、Windows Vista [僅限傳統型應用程式] |
| 最低支援的伺服器 | Windows Server 2003 SP1 [僅限傳統型應用程式] |
| 目標平台 | Windows |
| 標頭 | propvarutil.h |
| 程式庫 | Propsys.lib |
| Dll | Propsys.dll (6.0 版或更新版本) |
| 可轉散發套件 | Windows 桌面搜尋 (WDS) 3.0 |