GetAuxEntityDefNames

Description

Returns an array of strings, each of which corresponds to the name of one of the schema stateless record types.

The Array is never empty; at a minimum it will contain the names "users", "groups", "attachments", and "history" which correspond to the system-defined stateless record types.

Once you have the name of a stateless record type, you can retrieve the EntityDef Object for that record type by calling the GetEntityDef method.

Syntax

VBScript

session.GetAuxEntityDefNames 

Perl

$session->GetAuxEntityDefNames(); 

Identifier

Description

session

The Session object that represents the current database-access session.

Return value

For Visual Basic, a Variant containing an Array of Strings is returned. Each String contains the name of a stateless record type.

For Perl, a reference to an array of strings.

Examples

VBScript

set sessionObj = GetSession 

' Get the list of names for the stateless record types. 
entityDefNames = sessionObj.GetAuxEntityDefNames 

' Iterate over the non-system stateless record types 
for each name in entityDefNames
   if name <> "users" And name <> "groups" _ 
      And name <> "attachments" And name <> "history" Then 
         set entityDefObj = sessionObj.GetEntityDef(name) 

      ' Do something with the EntityDef object   
   End If 
Next 

Perl

$sessionObj = $entity->GetSession();

#Get an array containing the names of the stateless record

#types in the current database's schema.

$AuxEntityDefNames = $sessionObj->GetAuxEntityDefNames();

   

#Iterate over the state-based record types 

foreach $name ( @$AuxEntityDefNames){

   print $name, "\n";

   $EntityDefObj = $sessionObj->GetEntityDef( $name);

# Do something with the EntityDef object

   # ...

   }