IPXS_PDFVariant::Arr_GetDouble Method
From PDF XChange PDF SDK
| Line 2: | Line 2: | ||
{{#customTitle:IPXS_PDFVariant::Arr_GetDouble Method}} | {{#customTitle:IPXS_PDFVariant::Arr_GetDouble Method}} | ||
{{#parentPage:PXV:IPXS_PDFVariant|Arr_GetDouble Method|method}} | {{#parentPage:PXV:IPXS_PDFVariant|Arr_GetDouble Method|method}} | ||
| + | {{ToReview}} | ||
| − | Returns the element of | + | Returns the value of specified element of array as double. If specified element is neither <code>PVT_Integer</code> nor <code>PVT_Double</code> type, <code>nDefValue</code> is returned. |
== Syntax == | == Syntax == | ||
Revision as of 03:28, 18 May 2015
Returns the value of specified element of array as double. If specified element is neither PVT_Integer nor PVT_Double type, nDefValue is returned.
Contents
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.
- 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.
