IPXS_PDFVariant::Arr_GetDouble Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 4: | Line 4: | ||
{{ToWrite}} | {{ToWrite}} | ||
{{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. | |
| − | + | ||
== Syntax == | == Syntax == | ||
| Line 14: | Line 13: | ||
== Parameters == | == Parameters == | ||
;nIndex | ;nIndex | ||
| − | :[in] | + | :[in] Specifies an index of the element in the array. |
;nDefValue | ;nDefValue | ||
| − | :[in, defaultvalue( | + | :[in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a boolean value. |
;pVal | ;pVal | ||
| − | :[out, retval] | + | :[out, retval] Pointer to double variable that receives returned value. |
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code in other cases. | + | Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when <code>nDefValue</code> returned. |
== See Also == | == See Also == | ||
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]. | See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]. | ||
Revision as of 06:38, 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 boolean 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.
