Difference between revisions of "ACLASS()"
Yvonne.milne (Talk | contribs) m (1 revision) |
Yvonne.milne (Talk | contribs) |
||
| (One intermediate revision by the same user not shown) | |||
| 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. | ||
| − | |||
==Syntax== | ==Syntax== | ||
ACLASS(<array>,<object>) | ACLASS(<array>,<object>) | ||
| − | |||
==See Also== | ==See Also== | ||
| − | [[ADDPROPERTY()]], [[AMEMBERS() | + | [[ADDPROPERTY()]], [[AMEMBERS()]], [[COMPOBJ()]], [[CREATEOBJECT()]], [[DEFINE CLASS]], [[DISPLAY CLASSES]], [[DODEFAULT()]], [[FOREACH]], [[LIST CLASSES]], [[LOADOBJECT()]], [[NEWOBJECT()]], [[OBJECT()]], [[PRINT_HTML()]], [[PRINT_JSON()]], [[PRINT_R()]], [[PRINT_XML()]], [[REMOVEPROPERTY()]], [[REQUIRE_ONCE()]], [[SAVEOBJECT()]], [[SQL SELECT]], [[WITH]] |
| − | + | ||
==Description== | ==Description== | ||
| Line 15: | Line 12: | ||
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. | 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== | ==Example== | ||
| Line 22: | Line 18: | ||
</code> | </code> | ||
| − | |||
| − | |||
| − | |||
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Objects]] | [[Category:Objects]] | ||
| − | |||
Latest revision as of 06:57, 4 February 2013
Contents
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(), COMPOBJ(), CREATEOBJECT(), DEFINE CLASS, DISPLAY CLASSES, DODEFAULT(), FOREACH, LIST CLASSES, LOADOBJECT(), NEWOBJECT(), OBJECT(), PRINT_HTML(), PRINT_JSON(), PRINT_R(), PRINT_XML(), REMOVEPROPERTY(), REQUIRE_ONCE(), SAVEOBJECT(), SQL SELECT, 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)
