IPXS_PDFVariant::Arr_GetInt Method

From Tracker Software PDF SDK
Revision as of 05:08, 20 May 2015 by Dsbot (Talk | contribs) (Automatic page editing by robot)

Jump to: navigation, search

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.


HRESULT Arr_GetInt([in]                   ULONG  nIndex,
                   [in, defaultvalue(0)]  LONG   nDefValue,
                   [out, retval]          LONG*  pVal);


[in] Specifies the index of the array element.
[in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a numeric value.
[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