IPXS_PDFVariant::Arr_GetInt64 Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IPXS_PDFVariant::Arr_GetInt64 Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_GetInt64 Method}}
 
{{#parentPage:PXV:IPXS_PDFVariant|Arr_GetInt64 Method|method}}
 
{{#parentPage:PXV:IPXS_PDFVariant|Arr_GetInt64 Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
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.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 13:
 
== Parameters ==
 
== Parameters ==
 
;nIndex
 
;nIndex
:[in] Value of ULONG.
+
:[in] Specifies the index of the array element.
 
;nDefValue
 
;nDefValue
:[in, defaultvalue(0)] Value of LONGLONG.
+
:[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
 
;pVal
:[out, retval]  Pointer to LONGLONG.
+
:[out, retval]  Pointer to LONGLONG variable that receives returned value.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when <code>nDefValue</code> returned.
  
 
== See Also ==
 
== See Also ==
 
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
 
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].

Revision as of 04:08, 18 May 2015


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

Syntax

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

See also IPXS_PDFVariant.