GetHookDefNames

Description

Returns the list of named hooks associated with records of this type.

This method returns the list of Named hooks. Named hooks (also referred to as record hooks in the HCL Compass Designer user interface) are special functions used by HCL Compass form controls to implement specific tasks.

Syntax

VBScript

entitydef.GetHookDefNames field_def_name 

Perl

$entitydef->GetHookDefNames(field_def_name); 

Identifier

Description

entitydef

An EntityDef object corresponding to a record type in a schema.

Return value

For Visual Basic, a Variant containing a list of strings. Each string corresponds to the name of a hook associated with this record type. If no named hooks are associated with this record type, this method returns an EMPTY variant. For Perl, a reference to an array of strings.

Examples

VBScript

set sessionObj  = GetSession
set entityDefObj = sessionObj.GetEntityDef(GetEntityDefName())

sessionObj.OutputDebugString "Hooks of " & entityDefObj.GetName()

' List the record type's hooks
nameList = entityDefObj.GetHookDefNames()
For Each hookName in nameList
   sessionObj.OutputDebugString hookName
Next 

Perl

$sessionObj = $entity->GetSession();

$entityDefObj = $sessionObj->GetEntityDef($entity->GetEntityDefName());



$sessionObj->OutputDebugString("Hooks of
       ".$entityDefObj->GetName());



# List the record type's hooks

$nameList = $entityDefObj->GetHookDefNames();

foreach $hookName (@$nameList)
   {
 $sessionObj->OutputDebugString($hookName);

 }