GetActionSourceStateNames

Description

Returns the source state names associated with the current action.

Use this call to allow an external application to navigate the state transition matrix.

Whereas GetDefaultActionName returns the default action name associated with the current state, this method returns the source state names associated with the current action.

Like the other parts of an EntityDef object, the administrator sets the defined states using HCL Compass Designer. They cannot be set directly from the API.

Syntax

VBScript


entitydef.GetActionSourceStateNames actionDefName 

Perl


$entitydef->GetActionSourceStateNames(actionDefName); 
Identifier
Description
entitydef
An EntityDef object corresponding to a record type in a schema.
actionDefName
A String that identifies a valid action name.
Return value
For Visual Basic, a Variant containing an Array whose elements are strings. Each String names one state name. If the EntityDef object has no actions, the return value is an Empty Variant.

For Perl, a reference to an array of strings.