IPXS_PDFVariant::Arr_GetInt64 Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
Line 4: | Line 4: | ||
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetInt64|method}} | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetInt64|method}} | ||
− | 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> | + | 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>DefValue</code> is returned. |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT Arr_GetInt64([in] ULONG | + | <pre class="brush:cpp;gutter:false">HRESULT Arr_GetInt64([in] ULONG Index, |
− | [in, defaultvalue(0)] LONGLONG | + | [in, defaultvalue(0)] LONGLONG DefValue, |
− | [out, retval] LONGLONG* | + | [out, retval] LONGLONG* Val);</pre> |
== Parameters == | == Parameters == | ||
− | ; | + | ;Index |
:[in] Specifies the index of the array element. | :[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. | :[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 LONGLONG variable that receives returned value. | :[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_FALSE when <code> | + | 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:18, 12 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
, DefValue
is returned.
Syntax
HRESULT Arr_GetInt64([in] ULONG Index, [in, defaultvalue(0)] LONGLONG DefValue, [out, retval] LONGLONG* 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 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 DefValue
returned.