IPXS_PDFVariant::Arr_GetDouble Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 4: Line 4:
 
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetDouble|method}}
 
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetDouble|method}}
  
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.
+
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>DefValue</code> is returned.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetDouble([in]                    ULONG    nIndex,
+
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetDouble([in]                    ULONG    Index,
                       [in, defaultvalue(0.0)]  double  nDefValue,
+
                       [in, defaultvalue(0.0)]  double  DefValue,
                       [out, retval]            double*  nVal);</pre>
+
                       [out, retval]            double*  Val);</pre>
  
 
== Parameters ==
 
== Parameters ==
;nIndex
+
;Index
 
:[in] Specifies the index of the array element.
 
:[in] Specifies the index of the array element.
;nDefValue
+
;DefValue
 
:[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.
 
:[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.
;nVal
+
;Val
 
:[out, retval] Pointer to the double variable that receives the returned value.
 
:[out, retval] Pointer to the double variable that receives the returned value.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when <code>nDefValue</code> returned.
+
Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when <code>DefValue</code> returned.
  
 
== See Also ==
 
== See Also ==
 
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]
 
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]

Revision as of 06:17, 12 June 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, DefValue is returned.

Syntax

HRESULT Arr_GetDouble([in]                     ULONG    Index,
                      [in, defaultvalue(0.0)]  double   DefValue,
                      [out, retval]            double*  Val);

Parameters

Index
[in] Specifies the index of the array element.
DefValue
[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.
Val
[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 DefValue returned.

See Also

IPXS_PDFVariant