IPXS_PDFVariant::Arr_GetDouble Method

From Tracker Software PDF SDK
Revision as of 06:17, 12 June 2015 by Dsbot (Talk | contribs) (Automatic page editing by robot)

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, DefValue is returned.

Syntax

HRESULT Arr_GetDouble([in]                     ULONG    Index,
                      [in, defaultvalue(0.0)]  double   DefValue,
                      [out, retval]            double*  Val);

Parameters

Index
[in] Specifies the index of the array element.
DefValue
[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.
Val
[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 DefValue returned.

See Also

IPXS_PDFVariant