IPXS_PDFVariant::Arr_GetDouble Method

PDF Structures Layer > Interfaces > IPXS_PDFVariant > IPXS_PDFVariant::Arr_GetDouble Method

Returns a double value of specified element of array. If specified element has not PVT_Integer or PVT_Double type, nDefValue returned.

Syntax

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

Parameters

nIndex

[in] Specifies an index of the element in the array.

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.

pVal

[out, retval] Pointer to double variable that receives 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

See also IPXS_PDFVariant.