PropVariantToInt32WithDefault 函式 (propvarutil.h)
從 PROPVARIANT 結構擷取 Int32 值。 如果目前沒有任何值存在，則會傳回指定的預設值。
語法
PSSTDAPI_(LONG) PropVariantToInt32WithDefault(
[in] REFPROPVARIANT propvarIn,
[in] LONG lDefault
);
參數
[in] propvarIn
類型： REFPROPVARIANT
來源 PROPVARIANT 結構的參考。
[in] lDefault
類型： LONG
指定預設屬性值，用於目前沒有任何值存在的位置。
傳回值
類型： LONG
會傳回擷取的 LONG 值或預設值。
備註
這個協助程式函式用於呼叫應用程式預期 PROPVARIANT 保留 LONG 值的位置，而且如果不是的話，就會使用預設值。 例如，從屬性存放區取得值的應用程式可以使用這個來安全地擷取 Int32 屬性的 LONG 值。
如果來源 PROPVARIANT 的類型 VT_I4，這個協助程式函式會擷取 LONG 值。 否則，它會嘗試將 PROPVARIANT 結構中的值轉換成 LONG。 如果來源 PROPVARIANT 的類型VT_EMPTY或無法轉換，則 PropVariantToInt32WithDefault 會傳回 lDefault 所提供的預設值。 如需可能的轉換清單，請參閱 PropVariantChangeType 。
範例
下列範例要包含在較大的程式中，示範如何使用 PropVariantToInt32WithDefault 來存取 PROPVARIANT 中的 LONG 值。
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_FlagStatus, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_FlagStatus is expected to produce a VT_I4 or VT_EMPTY value.
// The application developer decided to treat VT_EMPTY or invalid values as 0
LONG iStatus = PropVariantToInt32WithDefault(propvar, 0);
// iStatus 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 |