Interface IUpdateRecordEvent

Update record event information.

Inherited Members
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
public interface IUpdateRecordEvent : IRecordSetEvent, IEntityEvent, IHostSessionEvent, IModelEvent, IEvent
Remarks

Update record event information. See UpdateRecord(IUpdateRecordEvent)

Properties

FieldWriteValues

Gets the set of fields and associated values to be written.

Declaration
IDictionary<string, string> FieldWriteValues { get; }
Property Value
Type Description
IDictionary<string, string>

A map of field names to field values.
Remarks

Gets the set of fields and associated values to be written. The values in the map can be modified and the map used as a parameter to the DefaultUpdateRecord() method.

Methods

DefaultUpdateRecord()

Executes the before update operation, write the fields and then execute the after update operation.

Declaration
void DefaultUpdateRecord()
Remarks

Executes the before update operation, write the fields and then execute the after update operation. The field values returned by the GetFieldWriteValues() method will be used.

Exceptions
Type Condition
ApptrieveException

Any error encountered will throw this exception.

DefaultUpdateRecord(IDictionary<string, string>)

Executes the before update operation, write the fields and then execute the after update operation.

Declaration
void DefaultUpdateRecord(IDictionary<string, string> Values)
Parameters
Type Name Description
IDictionary<string, string> Values

The fields and values to update.
Exceptions
Type Condition
ApptrieveException

Any error encountered will throw this exception.

WriteField(string, string)

Writes the specified field to the current record on the screen.

Declaration
void WriteField(string Name, string Value)
Parameters
Type Name Description
string Name

The field name.
string Value

The field value.
Remarks

Writes the specified field to the current record on the screen. If the cursor is not at the field's location, the VHI will issue a MoveCursor command. Upon successfully moving the cursor, the value will be written to the screen, firing the appropriate WriteField(IWriteFieldEvent) event, if any.

Exceptions
Type Condition
ApptrieveException

Any exception thrown will cause the field write to fail.