IPXS_PDFVariant::Arr_GetDouble Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
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.
+
Returns the value of a specified element of an array as a double value. If the specified element type is neither <code>PVT_Integer</code> nor <code>PVT_Double</code>, <code>nDefValue</code> is returned.
  
 
== Syntax ==
 
== Syntax ==
Line 16: Line 16:
 
:[in] Specifies the index of the array element.
 
:[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. If not specified, zero will be returned.
 
;pVal
 
;pVal
:[out, retval] Pointer to double variable that receives returned value.
+
:[out, retval] Pointer to the double variable that receives the returned value.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 13:47, 20 May 2015


Returns the value of a specified element of an array as a double value. If the specified element type is neither PVT_Integer nor PVT_Double, 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. If not specified, zero will be returned.
pVal
[out, retval] Pointer to the double variable that receives the 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

IPXS_PDFVariant.