IPXS_PDFVariant::Arr_GetInt Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Arr_GetInt Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_GetInt Method}}
{{#parentPage:PXV:IPXS_PDFVariant|Arr_GetInt Method|method}}
+
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetInt Method|method}}
 
+
  
 
Returns the value of a specified element of an array as an integer. If the specified element type is <code>PVT_Double</code>, the value 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.
 
Returns the value of a specified element of an array as an integer. If the specified element type is <code>PVT_Double</code>, the value 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.

Revision as of 14:09, 21 May 2015

Returns the value of a specified element of an array as an integer. If the specified element type is PVT_Double, the value will be truncated to an integer. If specified element type is neither PVT_Integer nor PVT_Double, 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. If not specified, zero will be returned.
pVal
[out, retval] Pointer to a LONG variable that receives the 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.