IPXS_PDFVariant::Arr_GetInt Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Arr_GetInt Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_GetInt Method}}
Line 23: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].

Revision as of 05:08, 20 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.

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

IPXS_PDFVariant.