VariantToDoubleArray 函式 (propvarutil.h)

發行項
03/01/2024

從 VARIANT 結構擷取 DOUBLE 值的陣列。

語法

PSSTDAPI VariantToDoubleArray(
  [in]  REFVARIANT var,
  [out] DOUBLE     *prgn,
  [in]  ULONG      crgn,
  [out] ULONG      *pcElem
);

參數

[in] var

類型： REFVARIANT

來源 VARIANT 結構的參考。

[out] prgn

類型： DOUBLE*

包含 crgnDOUBLE 值的緩衝區指標。當此函式傳回時，緩衝區已使用從來源 VARIANT 結構擷取的 *pcElemDOUBLE 元素初始化。

[in] crgn

類型： ULONG

prgn 所指向之緩衝區中的元素數目。

[out] pcElem

類型： ULONG*

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

傳回值

類型： HRESULT

如果成功，則傳回 S_OK ，否則傳回錯誤值，包括下列專案：

傳回碼	Description
TYPE_E_BUFFERTOOSMALL	來源 VARIANT 包含超過 crgn 值。
E_INVALIDARG	VARIANT 不是適當的類型。

備註

當呼叫的應用程式預期 VARIANT 會保存包含固定 數位 DOUBLE 值的陣列時，就會使用此協助程式函式。

如果來源 VARIANT 的類型為 VT_ARRAY |VT_DOUBLE，此函式會擷取最多 crgnDOUBLE 值，並將其放入 prgn所指向的緩衝區中。

如果 VARIANT 包含的項目超過符合 prgn 緩衝區的專案，此函式會傳回錯誤，並將 *pcElem 設定為 0。

範例

下列範例要包含在較大的程式中，示範如何使用 VariantToDoubleArray 來存取儲存在 VARIANT 中的 DOUBLE 陣列。

// VARIANT var;
// Assume variable var is initialized and valid.
DOUBLE rgDoubles[4]; // The application expects var to hold 4 DOUBLEs in an array.
ULONG cDoubles;

HRESULT hr = VariantToDoubleArray(var, rgDoubles, ARRAYSIZE(rgDoubles), &cFlags);

if (SUCCEEDED(hr))
{
    if (cFlags == ARRAYSIZE(rgDoubles))
    {
        // The application got 4 DOUBLEs which are now stored in rgDoubles.
    }
    else
    {
        // The application got *pcElem DOUBLEs which are stored in the first 
        // *pcElem elements of rgDoubles.
    }
}

規格需求

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