IPXS_PDFVariant::Arr_GetDouble Method

From Tracker Software PDF SDK
Jump to: navigation, search
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 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 the element of an array of doubles specified by nIndex. If specified element is neither <code>PVT_Integer</code> nor <code>PVT_Double</code> type, <code>nDefValue</code> is returned.
  
 
== Syntax ==
 
== Syntax ==
Line 12: Line 12:
 
== Parameters ==
 
== Parameters ==
 
;nIndex
 
;nIndex
:[in] Specifies an index of the element in the array.
+
:[in] Specifies the index of the array element.
 
;nDefValue
 
;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.
 
:[in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a numeric value.

Revision as of 11:53, 14 May 2015

Returns the element of an array of doubles specified by nIndex. If specified element is neither PVT_Integer nor PVT_Double type, nDefValue is returned.

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.