IPXS_PDFVariant::Arr_GetDouble Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Arr_GetDouble Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_GetDouble Method}}
{{#parentPage:PXV:IPXS_PDFVariant|Arr_GetDouble Method|method}}
+
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetDouble|method}}
{{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 ==
 
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetDouble([in]                    ULONG    nIndex,
 
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetDouble([in]                    ULONG    nIndex,
 
                       [in, defaultvalue(0.0)]  double  nDefValue,
 
                       [in, defaultvalue(0.0)]  double  nDefValue,
                       [out, retval]            double*  pVal);</pre>
+
                       [out, retval]            double*  nVal);</pre>
  
 
== Parameters ==
 
== Parameters ==
Line 15: Line 15:
 
:[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
+
;nVal
:[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 ==
Line 23: Line 23:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]

Latest revision as of 02:42, 15 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, nDefValue is returned.

Syntax

HRESULT Arr_GetDouble([in]                     ULONG    nIndex,
                      [in, defaultvalue(0.0)]  double   nDefValue,
                      [out, retval]            double*  nVal);

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.
nVal
[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