IPXS_PDFVariant::Arr_GetInt64 Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Arr_GetInt64 Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_GetInt64 Method}}
{{#parentPage:PXV:IPXS_PDFVariant|Arr_GetInt64 Method|method}}
+
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetInt64|method}}
{{ToReview}}
+
  
Returns the value of specified element of array as 64-bit signed integer. If specified element is <code>PVT_Double</code> type it value will be truncated to integer. If specified element is neither <code>PVT_Integer</code> nor <code>PVT_Double</code> type, <code>nDefValue</code> is returned.
+
Returns the value of the specified element of an array as a 64-bit signed integer. If the specified element type is <code>PVT_Double</code>, it will be truncated to an integer. If 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_GetInt64([in]                  ULONG      nIndex,
 
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetInt64([in]                  ULONG      nIndex,
 
                     [in, defaultvalue(0)]  LONGLONG  nDefValue,
 
                     [in, defaultvalue(0)]  LONGLONG  nDefValue,
                     [out, retval]          LONGLONG*  pVal);</pre>
+
                     [out, retval]          LONGLONG*  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 LONGLONG variable that receives returned value.
 
:[out, retval]  Pointer to LONGLONG variable that receives returned 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 03:42, 15 June 2015

Returns the value of the specified element of an array as a 64-bit signed integer. If the specified element type is PVT_Double, it will be truncated to an integer. If specified element type is neither PVT_Integer nor PVT_Double, nDefValue is returned.

Syntax

HRESULT Arr_GetInt64([in]                   ULONG      nIndex,
                     [in, defaultvalue(0)]  LONGLONG   nDefValue,
                     [out, retval]          LONGLONG*  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 LONGLONG 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

IPXS_PDFVariant