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}} | {{ToReview}} | ||
Returns a double value of specified element of array. If specified element has not <code>PVT_Integer</code> or <code>PVT_Double</code> type, <code>nDefValue</code> returned. | Returns a double value of specified element of array. If specified element has not <code>PVT_Integer</code> or <code>PVT_Double</code> type, <code>nDefValue</code> returned. | ||
| Line 15: | Line 14: | ||
:[in] Specifies an index of the element in the array. | :[in] Specifies an index of the element in the array. | ||
;nDefValue | ;nDefValue | ||
| − | :[in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a | + | :[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 | ;pVal | ||
:[out, retval] Pointer to double variable that receives returned value. | :[out, retval] Pointer to double variable that receives returned value. | ||
Revision as of 07:40, 7 May 2015
Returns a double value of specified element of array. If specified element has not PVT_Integer or PVT_Double type, nDefValue returned.
Contents
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.
