PropVariantToInt16 函式 (propvarutil.h)

擷取 PROPVARIANT 結構的 Int16 屬性值。

語法

PSSTDAPI PropVariantToInt16(
  [in]  REFPROPVARIANT propvarIn,
  [out] SHORT          *piRet
);

參數

[in] propvarIn

類型： REFPROPVARIANT

來源 PROPVARIANT 結構的參考。

[out] piRet

類型： SHORT*

當此函式傳回時，如果存在，則包含擷取的屬性值;否則為 0。

傳回值

類型： HRESULT

如果此函式成功，則會傳回 S_OK。 否則，它會傳回 HRESULT 錯誤碼。

備註

此協助程式函式用於呼叫應用程式預期 PROPVARIANT 保留 Int16 值的位置。 例如，從屬性存放區取得值的應用程式可以使用這個來安全地擷取 Int16 屬性的 Int16 值。

如果來源 PROPVARIANT 的類型 VT_I2，這個協助程式函式會擷取 Int16 值。 否則，它會嘗試將 PROPVARIANT 結構中的值轉換成 Int16。 如果無法轉換， PropVariantToInt16 會傳回失敗碼，並將 piRet 設定為0。 如需可能轉換的清單 ，請參閱 PropVariantChangeType 。 請注意，VT_EMPTY已成功轉換為 0。

範例

下列範例要包含在較大的程式中，示範如何使用 PropVariantToInt16 存取 PROPVARIANT 中的 Int16 值。

// IPropertyStore *ppropstore;

// Assume variable ppropstore is initialized and valid

PROPVARIANT propvar = {0};

HRESULT hr = ppropstore->GetValue(PKEY_Image_ResolutionUnit, &propvar);

if (SUCCEEDED(hr))

{

     // PKEY_Image_ResolutionUnit is expected to produce a VT_I2 or VT_EMPTY value.

     // PropVariantToInt16 will convert VT_EMPTY to 0.

     INT16 iUnit;

     hr = PropVariantToInt16(propvar, & iUnit);

     if (SUCCEEDED(hr))

     {

             // iUnit is now valid

     }

     else

     {

             // iUnit 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