PropVariantToDoubleVector 函式 (propvarutil.h)

發行項
03/05/2024

從 PROPVARIANT 結構擷取雙精度浮點數的向量。

語法

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

參數

[in] propvar

類型： REFPROPVARIANT

來源 PROPVARIANT 結構的參考。

[out] prgn

類型： DOUBLE*

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

[in] crgn

類型： ULONG

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

[out] pcElem

類型： ULONG*

當此函式傳回時，包含從來源 PROPVARIANT 結構擷取的雙精度浮點數。

傳回值

類型： HRESULT

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

備註

此協助程式函式用於呼叫端應用程式預期 PROPVARIANT 保留具有固定項目數的雙向量值的位置。

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

範例

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_GPS_DestLongitude, &propvar);
if (SUCCEEDED(hr))
{
         // PKEY_GPS_DestLongitude is expected to produce a VT_VECTOR | VT_R8 with three values, or VT_EMPTY
         // PropVariantToDoubleVector will return an error for VT_EMPTY
         DOUBLE rgLongitude[3];
         ULONG cElem;
         hr = PropVariantToDoubleVector(propvar, &rgLongitude, ARRAYSIZE(rgLongitude), &cElem);
         if (SUCCEEDED(hr))
         {
                 if (cElem == ARRAYSIZE(rgLongitude))
                 {
                          // rgLongitude contains 3 doubles representing the degrees, minutes, and seconds of longitude
                 }
                 else
                 {
                          // The first cElem doubles from propvar are stored in the first 3 elements of rgLongitude
         }
         else
         {
                 // propvar either is VT_EMPTY, or contains something other than a vector of 3 doubles
         }
         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