PropVariantToUInt16WithDefault 函式 (propvarutil.h)
從 PROPVARIANT 結構擷取不帶正負號的簡短值。 如果沒有值存在，則會傳回指定的預設值。
語法
PSSTDAPI_(USHORT) PropVariantToUInt16WithDefault(
[in] REFPROPVARIANT propvarIn,
[in] USHORT uiDefault
);
參數
[in] propvarIn
類型： REFPROPVARIANT
來源 PROPVARIANT 結構的參考。
[in] uiDefault
類型： USHORT
指定預設屬性值，用於目前不存在任何值的位置。
傳回值
類型： 不帶正負號的簡短
傳回擷取 的不帶正負號短 值或預設值。
備註
此協助程式函式用於呼叫應用程式預期 PROPVARIANT 保留 不帶正負號的簡短 值的位置。 例如，從屬性存放區取得值的應用程式可以使用這個來安全地擷取 UInt16 屬性 的不帶正負號短 值。
如果來源 PROPVARIANT 的類型 VT_UI2，這個協助程式函式會擷取 不帶正負號的簡短 值。 否則，它會嘗試將 PROPVARIANT 結構中的值轉換成 不帶正負號的簡短。 如果無法轉換， PropVariantToUInt16 會傳回失敗碼並將 puiRet 設定為 0。 如需可能轉換的清單 ，請參閱 PropVariantChangeType 。 請注意， VT_EMPTY 已成功轉換為 0。
範例
下列範例要包含在較大的程式中，示範如何使用 PropVariantToUInt16 存取 PROPVARIANT 中的不帶正負號的簡短值。
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_FlagColor, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_FlagColor is expected to produce a VT_UI2 or VT_EMPTY value.
// PropVariantToInt32 will convert VT_EMPTY to 0.
USHORT uColor;
hr = PropVariantToUInt32(propvar, & uColor);
if (SUCCEEDED(hr))
{
// uColor is now valid
}
else
{
// uColor 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 |