IPXS_PDFVariant::Arr_GetDouble Method

From Tracker Software PDF SDK
Revision as of 12:47, 20 May 2015 by Craig (Talk | contribs)

Jump to: navigation, search


Returns the value of a specified element of an array as a double value. If the specified element type is neither PVT_Integer nor PVT_Double, nDefValue is returned.

Syntax

HRESULT Arr_GetDouble([in]                     ULONG    nIndex,
                      [in, defaultvalue(0.0)]  double   nDefValue,
                      [out, retval]            double*  pVal);

Parameters

nIndex
[in] Specifies the index of the array element.
nDefValue
[in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a numeric value. If not specified, zero will be returned.
pVal
[out, retval] Pointer to the double variable that receives the returned value.

Return Value

Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when nDefValue returned.

See Also

IPXS_PDFVariant.