Difference between revisions of "ACLASS()"

From Recital Documentation Wiki
Jump to: navigation, search
(Class)
Line 1: Line 1:
 
 
 
==Purpose==
 
==Purpose==
 
Function to place the class name of an object and its ancestors into a variable array.
 
Function to place the class name of an object and its ancestors into a variable array.
Line 26: 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:Objects]]
 
[[Category:Objects]]
 
[[Category:Objects Functions]]
 
[[Category:Objects Functions]]

Revision as of 16:36, 25 November 2009

Purpose

Function to place the class name of an object and its ancestors into a variable array.


Syntax

ACLASS(<array>,<object>)


See Also

ADDPROPERTY(), AMEMBERS(), CLASS, DEFINE CLASS, COMPOBJ(), CREATEOBJECT(), DODEFAULT(), METHOD, NEWOBJECT(), REMOVEPROPERTY(), SET CLASSLIBRARY, WITH


Description

The ACLASS() function places the class name of an object and its ancestors into a variable one-dimensional array. The name of the object is specified in <object>. The name if the array is specified in <array>. If the array does not exist, it is created. If the array is smaller or larger than required, it is resized. The object class name is placed in the first element of the array, the class name of its immediate parent in the second element and so on through the class hierarchy.

The ACLASS() function returns the number of class names placed in the array. If the array cannot be created, the ACLASS() function will return 0.


Example

nHierarchy = aclass(aHierarchy,myObject)


Products

Recital Server, Recital