IPXS_PDFVariant::Arr_GetInt64 Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#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}} | ||
| − | |||
| − | Returns the value of specified element of array as 64-bit signed integer. If specified element is <code>PVT_Double</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>nDefValue</code> is returned. | ||
== Syntax == | == Syntax == | ||
| Line 16: | Line 16: | ||
:[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 | ;pVal | ||
:[out, retval] Pointer to LONGLONG variable that receives returned value. | :[out, retval] Pointer to LONGLONG variable that receives returned value. | ||
Revision as of 13:55, 20 May 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* 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. If not specified, zero will be returned.
- 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.
