Interface IExecuteProcedureEvent

Execute procedure event information.

Inherited Members

IHostSessionEvent.HostSession

IModelEvent.CurrentOperation

IModelEvent.CurrentProcedure

IModelEvent.ModelContext

IModelEvent.ClientSession

IEvent.Logger

IEvent.CheckForTimeout()

IEvent.EventStack

IEvent.GetHandlerProperty(string)

IEvent.IsDesignEnvironment()

IEvent.CreateUserErrorMessage(string)

IEvent.CreateErrorMessage(int)

IEvent.CreateErrorMessage(int, object[])

Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI

Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll

Syntax

public interface IExecuteProcedureEvent : IHostSessionEvent, IModelEvent, IEvent

Remarks

Execute procedure event information. See ExecuteProcedure(IExecuteProcedureEvent)

Properties

CaseSensitive

Determine if comparisons should be done case-sensitively.

Declaration

bool CaseSensitive { get; }

Property Value

Type	Description
bool	True if comparisons should be case-sensitive.

MaxRows

Gets the maximum number of rows requested.

Declaration

int MaxRows { get; }

Property Value

Type	Description
int	The maximum rows.

ProcedureInputParameters

Gets the procedure's input parameters.

Declaration

IProcedureParameters[] ProcedureInputParameters { get; }

Property Value

Type	Description
IProcedureParameters[]	One or more sets of input parameters.

Remarks

Gets the procedure's input parameters. Select, Update and Delete procedures will have only one set of input parameters. Insert procedures, however, can have one or more sets of input parameters.

ProcedureMetaData

Gets the metadata for this procedure.

Declaration

IProcedureMetaData ProcedureMetaData { get; }

Property Value

Type	Description
IProcedureMetaData	The metadata for the procedure.

Exceptions

Type	Condition
ApptrieveException	Throws ApptrieveException if an error occurs obtaining the metadata.

ProcedureName

Gets the procedure name.

Declaration

string ProcedureName { get; }

Property Value

Type	Description
string	The name of the procedure.

TableName

Gets the table name.

Declaration

string TableName { get; }

Property Value

Type	Description
string	The name of the table.

Methods

CreateProcedureRecordSet()

Create an empty IMutableProcedureRecordSet configured with the procedure's outputs as columns.

Declaration

IMutableProcedureRecordSet CreateProcedureRecordSet()

Returns

Type	Description
IMutableProcedureRecordSet	The output record set.

DefaultProcedure()

Execute the default procedure implementation with the input parameters returned from GetProcedureInputParameters.

Declaration

IMutableProcedureRecordSet DefaultProcedure()

Returns

Type	Description
IMutableProcedureRecordSet	The procedure output recordset if its a select procedure, otherwise null.

Exceptions

Type	Condition
ApptrieveException	Throws ApptrieveException if an error occurs executing the procedure.

DefaultProcedure(IProcedureParameters, int)

Execute the default procedure implementation with the specified set of input parameters.

Declaration

IMutableProcedureRecordSet DefaultProcedure(IProcedureParameters input, int maxRows)

Parameters

Type	Name	Description
IProcedureParameters	input	Input the procedure input parameters.
int	maxRows	MaxRows the maximum number of rows to return.

Returns

Type	Description
IMutableProcedureRecordSet	The procedure output recordset if this is a select procedure, otherwise null.

Exceptions

Type	Condition
ApptrieveException	Throws ApptrieveException if an error occurs executing the procedure.

DefaultProcedure(IProcedureParameters[], int)

Execute the default procedure implementation with the specified sets of input parameters.

Declaration

IMutableProcedureRecordSet DefaultProcedure(IProcedureParameters[] inputs, int maxRows)

Parameters

Type	Name	Description
IProcedureParameters[]	inputs	Inputs to the procedure.
int	maxRows	MaxRows to be returned.

Returns

Type	Description
IMutableProcedureRecordSet	The output recordset if this is a select procedure, otherwise null.

Exceptions

Type	Condition
ApptrieveException	Throws ApptrieveException if an error occurs executing the procedure.