propVariantToInt32 函式 (propvarutil.h)
擷取 PROPVARIANT 結構的 Int32 屬性值。 如果無法擷取任何值,則會指派預設值。
語法
PSSTDAPI PropVariantToInt32(
[in] REFPROPVARIANT propvarIn,
[out] LONG *plRet
);
參數
[in] propvarIn
類型: REFPROPVARIANT
來源 PROPVARIANT 結構的參考。
[out] plRet
類型: LONG*
當此函式傳回時,如果存在,則包含擷取的值;否則為 0。
傳回值
類型: HRESULT
如果此函式成功,則會傳回 S_OK。 否則,它會傳回 HRESULT 錯誤碼。
備註
此協助程式函式用於呼叫應用程式預期 PROPVARIANT 保留 Int32 值的位置。 例如,從屬性存放區取得值的應用程式可以使用這個來安全地擷取 Int32 屬性的 Int32 值。
如果來源 PROPVARIANT 的類型 VT_I4,這個協助程式函式會擷取 long 值。 否則,它會嘗試將 PROPVARIANT 結構中的值轉換成 long。 如果無法轉換, PropVariantToInt32 會傳回失敗碼,並將 plRet 設定為 0。 如需可能轉換的清單 ,請參閱 PropVariantChangeType 。 請注意, VT_EMPTY 已成功轉換為 0。
範例
// 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.
// PropVariantToInt32 will convert VT_EMPTY to 0.
INT32 iStatus;
hr = PropVariantToInt32(propvar, &iStatus);
if (SUCCEEDED(hr))
{
// iStatus is now valid
}
else
{
// iStatus is always 0
}
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 |