====== OBJECTLIST method (System) ======


 
==== Description ====
 
 
This method returns a list of object IDs that match the specified filter criteria and options.
 
 
 
 
==== Syntax ====
 
<code>
ObjList = Exec_Method( "SYSTEM", "OBJECTLIST", ParentID, TypeID, RecurseFlag, 
                       NoSortFlag, VisibleOnlyFlag, PageNumber )

</code>
 
 
 
==== Parameters ====
 
 
 
^Name^Required^Description^
|ParentID|No|If specified then only objects that are children of this object will be returned.|
|TypeID|No|If specified then only objects of this type are returned, otherwise objects of any type may be returned.|
|RecurseFlag|No|Normally, when the ParentID parameter is set only direct children of that parent will be returned.  If RecurseFlag is set to TRUE$ then all objects that are descendants of ParentID are returned.|
|NoSortFlag|No|By default the list of objects returned in alphabetical order – if this parameter is TRUE$ then the list is returned with respect to the Z-order instead.|
|VisibleOnlyFlag|No|If TRUE$ then only visible objects are returned.|
|PageNumber|No|If specified then only objects with the same PageNumber property will be returned.|

 


 
==== Returns ====
 
 
An @fm-delimited list of PS objects matching the filter criteria, or null if no matches are found.
 
 
 
 
==== Remarks ====
 
 
This method uses the Windows API EnumChildWindows function internally – for further information please see the MSDN website.
 
 
 
 
==== Example ====
 
<code>
 
//// Return a sorted list of all objects in the system//
   ObjList = Exec_Method( "SYSTEM", "OBJECTLIST", "", "" )
   
   //// Return a sorted list of all EDITFIELD objects in the system//
   ObjList = Exec_Method( "SYSTEM", "OBJECTLIST", "", "EDITFIELD" )
   
   //// Return a z-order list of direct child objects for the MYWIN form//
   ObjList = Exec_Method( "SYSTEM", "OBJECTLIST", "MYWIN", "", FALSE$, TRUE$ )
   
   //// Return a z-order list of ALL children for the MYWIN form//
   ObjList = Exec_Method( "SYSTEM", "OBJECTLIST", "MYWIN", "", TRUE$, TRUE$ )

   //// Return a sorted list of ALL EDITFIELD children for the MYWIN form//
   ObjList = Exec_Method( "SYSTEM", "OBJECTLIST", "MYWIN", "EDITFIELD", TRUE$, FALSE$ )  
   
   //// Return a sorted list of ALL visible children for the MYWIN form//
   ObjList = Exec_Method( "SYSTEM", "OBJECTLIST", "MYWIN", "", TRUE$, TRUE$, TRUE$ )
   
   //// Return a z-order list of all visible children on page 2 of the MYWIN form//
   ObjList = Exec_Method( "SYSTEM", "OBJECTLIST", "MYWIN", "", TRUE$, FALSE$, TRUE$, 2 )
 
 
 

</code>

 
==== See Also ====
 
 
System Monitor OL and LO commands, Common TYPE property, Common GUI PAGENUMBER property, Common GUI PARENT property, Common GUI PARENTFRAME property, Common GUI VISIBLE property.