variantToBoolean 函式 (propvarutil.h)
從 VARIANT 結構擷取布爾屬性值。 如果無法擷取任何值，則會指派預設值。
語法
PSSTDAPI VariantToBoolean(
[in] REFVARIANT varIn,
[out] BOOL *pfRet
);
參數
[in] varIn
類型： REFVARIANT
來源 VARIANT 結構的參考。
[out] pfRet
類型： BOOL*
當此函式傳回時，如果存在，則包含擷取的值;否則為 FALSE。
傳回值
類型： HRESULT
如果此函式成功，則會傳回 S_OK。 否則，它會傳回 HRESULT 錯誤碼。
備註
當呼叫的應用程式預期 VARIANT 保留布爾值時，會使用此協助程式函式。 例如，從Shell資料夾取得值的應用程式可以使用此函式，從其中一個資料夾的 Boolean 屬性安全地擷取值。
如果來源 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 |
| 程式庫 | Propsys.lib |
| Dll | Propsys.dll (6.0 版或更新版本) |
| 可轉散發套件 | Windows 桌面搜尋 (WDS) 3.0 |