PropVariantToInt16Vector 函式 (propvarutil.h)

發行項
08/08/2024

從 PROPVARIANT 結構擷取 Int16 值的向量。

語法

PSSTDAPI PropVariantToInt16Vector(
  [in]  REFPROPVARIANT propvar,
  [out] SHORT          *prgn,
  [in]  ULONG          crgn,
  [out] ULONG          *pcElem
);

參數

[in] propvar

類型： REFPROPVARIANT

來源 PROPVARIANT 結構的參考。

[out] prgn

類型： SHORT*

指向包含 crgnSHORT 值的緩衝區。當此函式傳回時，緩衝區已使用從來源 PROPVARIANT 結構擷取的pcElem SHORT元素初始化。

[in] crgn

類型： ULONG

元素中prgn所指向的緩衝區大小。

[out] pcElem

類型： ULONG*

當此函式傳回時，包含從來源 PROPVARIANT 結構擷取的 Int16 元素計數。

傳回值

類型： HRESULT

此函式可以傳回下列其中一個值。

傳回碼	描述
S_OK	如果成功，則傳回 S_OK ，否則傳回錯誤值。
TYPE_E_BUFFERTOOSMALL	來源 PROPVARIANT 包含超過 crgn 值。 prgn 指向的緩衝區。
E_INVALIDARG	PROPVARIANT 不是適當的類型。

備註

此協助程式函式用於呼叫端應用程式預期 PROPVARIANT 以固定數目的專案保存 Int16 向量值的位置。

如果來源 PROPVARIANT 的類型VT_VECTOR |VT_I2或VT_ARRAY |VT_I2，此協助程式函式會擷取最多 crgn Int16 值，並將其放入 prgn 所指向的緩衝區中。如果 PROPVARIANT 包含的項目超過會放入 prgn 緩衝區中的元素，此函式會傳回錯誤，並將 pcElem 設定為 0。

範例

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid
SHORT rgShorts[4]; // The application is expecting propvar to hold 4 Int16s in a vector
ULONG cElems;
HRESULT hr = PropVariantToInt16Vector(propvar, rgShorts, ARRAYSIZE(rgShorts), &cElems);
if (SUCCEEDED(hr))
{
     if (cElems == ARRAYSIZE(rgShorts))
     {
         // The application got 4 Int16s which are now stored in rgShorts
     }
     else
     {
         // The application got cElems which are stored in the first cElems elements of rgShorts
     }
}

規格需求

需求	值
最低支援的用戶端	Windows XP 搭配 SP2、Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 SP1 [僅限傳統型應用程式]
目標平台	Windows
標頭	propvarutil.h
程式庫	Propsys.lib
Dll	Propsys.dll (6.0 版或更新版本)
可轉散發套件	Windows 桌面搜尋 (WDS) 3.0