GetEntityDefName

Description

Returns the name of the EntityDef object that is the template for this object.

To get the corresponding EntityDef object, call the Session object's GetEntityDef method.

Before using the methods of EntityDef object, you should look at the methods of Entity to see if one of them returns the information you need. Some of the more common information available in an EntityDef object can also be obtained directly from methods of Entity.

Syntax

VBScript

entity.GetEntityDefName 

Perl

$entity->GetEntityDefName(); 

Identifier

Description

entity

An Entity object representing a user data record. Inside a hook, if you omit this part of the syntax, the Entity object corresponding to the current data record is assumed (VBScript only).

Return value

A String containing the name of the EntityDef object upon which this object is based.

Examples

VBScript

set sessionObj = GetSession 

' Get the EntityDef of the record using GetEntityDefName 
entityDefName = GetEntityDefName 
set entityDefObj = sessionObj.GetEntityDef(entityDefName) 

Perl

$sessionobj = $entity->GetSession();



# Get the EntityDef of the record using GetEntityDefName 



$entitydefname = $entity->GetEntityDefName();

$entitydefobj = $sessionobj->GetEntityDef($entitydefname);