Difference between revisions of "AELEMENT()"

From Recital Documentation Wiki
Jump to: navigation, search
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Class==
 
Array Processing
 
 
 
 
==Purpose==
 
==Purpose==
 
Function to return the number of an array element from the element subscripts
 
Function to return the number of an array element from the element subscripts
Line 12: Line 8:
  
 
==See Also==
 
==See Also==
[[AADD()]], [[AAVERAGE()]], [[ABROWSE()]], [[ACHOICE()]], [[ACOL()]], [[ACOPY()]], [[ADEL()]], [[ADESC()]], [[ADIR()]], [[AFIELDS()]], [[AFILL()]], [[AINS()]], [[ALEN()]], [[AMAX()]], [[AMIN()]], [[APPEND FROM ARRAY]], [[AROW()]], [[ASCAN()]], [[ASIZE()]], [[ASORT()]], [[ASTORE()]], [[ASTRING()]], [[ASUBSCRIPT()]], [[ASUM()]], [[COPY TO ARRAY]], [[DECLARE]], [[DIMENSION]], [[GATHER]], [[LOCAL]], [[PRIVATE]], [[PUBLIC]], [[RELEASE]], [[RESTORE]], [[SAVE]], [[SCATTER]]
+
[[AADD()]], [[AAVERAGE()]], [[ABROWSE()]], [[ACHOICE()]], [[ACOL()]], [[ACOPY()]], [[ADEL()]], [[ADESC()]], [[ADIR()]], [[AFIELDS()]], [[AFILL()]], [[AINS()]], [[ALEN()]], [[AMAX()]], [[AMIN()]], [[APPEND FROM ARRAY]], [[AROW()]], [[ARRAY()]], [[ASCAN()]], [[ASIZE()]], [[ASORT()]], [[ASTORE()]], [[ASTRING()]], [[ASUBSCRIPT()]], [[ASUM()]], [[COPY TO ARRAY]], [[DECLARE]], [[DIMENSION]], [[GATHER]], [[IN_ARRAY()]], [[IS_ARRAY()]], [[LOCAL]], [[PRIVATE]], [[PUBLIC]], [[RELEASE]], [[RESTORE]], [[SAVE]], [[SCATTER]]
 +
 
  
 
==Description==
 
==Description==
The AELEMENT() function returns the element number from a two-dimensional array.  The <array> name of a two-dimensional array and the row <expN1> and column <expN2> must be specified.  From the row and column values of the two-dimensional array AELEMENT() will return the element number.
+
The AELEMENT() function returns the element number from a two-dimensional array.  The <array> is the name of a two-dimensional array, <expN1> is the row number and <expN2> the column number.  If <expN2> is omitted, the column defaults to 1.  From the row and column values of the two-dimensional array AELEMENT() will return the element number.
  
  
Line 27: Line 24:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital Server, Recital  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Category:Array Processing]]
 
[[Category:Array Processing]]
 
[[Category:Array Processing Functions]]
 
[[Category:Array Processing Functions]]

Latest revision as of 13:49, 26 July 2010

Purpose

Function to return the number of an array element from the element subscripts


Syntax

AELEMENT(<array>, <expN1> [,<expN2>])


See Also

AADD(), AAVERAGE(), ABROWSE(), ACHOICE(), ACOL(), ACOPY(), ADEL(), ADESC(), ADIR(), AFIELDS(), AFILL(), AINS(), ALEN(), AMAX(), AMIN(), APPEND FROM ARRAY, AROW(), ARRAY(), ASCAN(), ASIZE(), ASORT(), ASTORE(), ASTRING(), ASUBSCRIPT(), ASUM(), COPY TO ARRAY, DECLARE, DIMENSION, GATHER, IN_ARRAY(), IS_ARRAY(), LOCAL, PRIVATE, PUBLIC, RELEASE, RESTORE, SAVE, SCATTER


Description

The AELEMENT() function returns the element number from a two-dimensional array. The <array> is the name of a two-dimensional array, <expN1> is the row number and <expN2> the column number. If <expN2> is omitted, the column defaults to 1. From the row and column values of the two-dimensional array AELEMENT() will return the element number.


Example

declare test[4,4]
? aelement(test, 3,2)
        10


Products

Recital Server, Recital