IPXS_PDFVariant::Arr_GetInt Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 2: | Line 2: | ||
{{#customTitle:IPXS_PDFVariant::Arr_GetInt Method}} | {{#customTitle:IPXS_PDFVariant::Arr_GetInt Method}} | ||
{{#parentPage:PXV:IPXS_PDFVariant|Arr_GetInt Method|method}} | {{#parentPage:PXV:IPXS_PDFVariant|Arr_GetInt Method|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Returns the value of specified element of array as 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] | + | :[in] Specifies the index of the array element. |
;nDefValue | ;nDefValue | ||
| − | :[in, defaultvalue(0)] | + | :[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 LONG. | + | :[out, retval] Pointer to LONG 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 03:32, 18 May 2015
Returns the value of specified element of array as 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.
Contents
Syntax
HRESULT Arr_GetInt([in] ULONG nIndex,
[in, defaultvalue(0)] LONG nDefValue,
[out, retval] LONG* 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 LONG 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.
