Class ProcedureEventHandler
Abstract base class for a procedure event handler.
Implements
Inherited Members
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
public abstract class ProcedureEventHandler : MarshalByRefObject, IEventHandler
Remarks
Abstract base class for a procedure event handler. All classes that extend this class appear as procedure event handlers in the VHI design tool.
Methods
ExecuteProcedure(IExecuteProcedureEvent)
Called to execute a procedure.
Declaration
public virtual IProcedureRecordSet ExecuteProcedure(IExecuteProcedureEvent vsEvent)
Parameters
Type | Name | Description |
---|---|---|
IExecuteProcedureEvent | vsEvent | The event instance. |
Returns
Type | Description |
---|---|
IProcedureRecordSet | The procedure result or null if none. |
Remarks
Called to execute a procedure. The event can either be used to modify the input and/or output of the default procedure, or can be used to fully script a procedure's implementation.
Exceptions
Type | Condition |
---|---|
ApptrieveException | If an exception is thrown from this event the procedure will fail. |
InitializeLifetimeService()
Tell the .NET Framework remoting system that instances of this type have an infinite lifetime.
Declaration
public override object InitializeLifetimeService()
Returns
Type | Description |
---|---|
object | A null value. |