Object Class: _getEvent

Object Class: _getEvent

Returns metadata for a specific registered event on a class or object

Syntax

Syntax

return = objectName._getEvent( eventName, metadata );

return = objectName._getEvent( eventName, metadata, method );

Argument Type Use Description

return Numeric Return returns a value indicating whether the event was successfully retrieved: 0 if successful, 1 if not successful

eventName Character Input specifies the name of the event to retrieve

metadata List Update specifies the list returned containing the named items for the event metadata

method Character Input specifies the method name associated with eventName. This is required when multiple events exist by the same name to uniquely identify the event to retrieve

Argument	Type	Use	Description
return	Numeric	Return	returns a value indicating whether the event was successfully retrieved: 0 if successful, 1 if not successful
eventName	Character	Input	specifies the name of the event to retrieve
metadata	List	Update	specifies the list returned containing the named items for the event metadata
method	Character	Input	specifies the method name associated with eventName. This is required when multiple events exist by the same name to uniquely identify the event to retrieve

Chapter Contents
Previous
Next
Top of Page