.NET ScriptAPI Method Reference

.NET ScriptAPI Method Reference

Show / Hide Table of Contents
  • Attachmate.Verastream.HostIntegrator.ScriptAPI
    • AppConnAidKey
    • ApptrieveException
    • AttributeEventHandler
    • ColumnType
    • ColumnValue
    • ContextType
    • CursorPosition
    • DescriptionAttribute
    • EchoType
    • EntityEventHandler
    • ErrorMessage
    • EventHandlerConstant
    • EventHandlerType
    • EventInfo
    • EventTimeoutException
    • FieldEventHandler
    • HostColor
    • HostFont
    • IApplyFilterEvent
    • IAttributeEvent
    • IAttributeMetaData
    • IAuthenticateUserEvent
    • IClientConnectedEvent
    • IClientDisconnectedEvent
    • IClientSession
    • IClientSessionCreatedEvent
    • IClientSessionDestroyedEvent
    • IColumnMetaData
    • IEntityArrivalEvent
    • IEntityDepartureEvent
    • IEntityEvent
    • IEntityMoveCursorEvent
    • IErrorReportedEvent
    • IEvent
    • IEventHandler
    • IExecuteLoginEvent
    • IExecuteLogoutEvent
    • IExecuteOperationEvent
    • IExecuteProcedureEvent
    • IFieldEvent
    • IFieldLocation
    • IFieldMetaData
    • IFormatErrorEvent
    • IGetCurrentHostRecordEvent
    • IGetRecordTypeEvent
    • IHostSession
    • IHostSessionCreatedEvent
    • IHostSessionDestroyedEvent
    • IHostSessionEvent
    • IInsertRecordEvent
    • IIsTerminatedEvent
    • ILifeCycleEvent
    • ILinearTerminalRegion
    • ILogger
    • IMetaData
    • IModelContext
    • IModelCursorEvent
    • IModelEvent
    • IModelLoadedEvent
    • IModelMoveCursorBackwardEvent
    • IModelMoveCursorEvent
    • IModelMoveCursorForwardEvent
    • IModelRecord
    • IModelRecordSet
    • IModelUnloadedEvent
    • IMutableProcedureRecord
    • IMutableProcedureRecordSet
    • IOperationMetaData
    • IParseRecordEvent
    • IParseScreenEvent
    • IProcedureMetaData
    • IProcedureParameters
    • IProcedureRecord
    • IProcedureRecordSet
    • IProcessStringEvent
    • IReadAttributeEvent
    • IReadFieldEvent
    • IRecord
    • IRecordEvent
    • IRecordLocation
    • IRecordSet
    • IRecordSetContext
    • IRecordSetEvent
    • IRecordSetMetaData
    • IRecordSetScreen
    • IRectangularTerminalRegion
    • IScriptHostSession
    • ITerminalAttributes
    • ITerminalCell
    • ITerminalRegion
    • IUnrecognizedScreenEvent
    • IUpdateRecordEvent
    • IVariableMetaData
    • IWriteAttributeEvent
    • IWriteAttributesEvent
    • IWriteFieldEvent
    • IndexValue
    • LifeCycleEventHandler
    • MetaDataType
    • ModelEventHandler
    • OperationEventHandler
    • ProcedureEventHandler
    • ProcedureType
    • RecordSetEventHandler
    • RecordType
    • RegionType
    • RowValue
    • ScreenSize
    • ScrollDirection
    • ScrollMovement
    • TimeoutAttribute
    • VariableInitialization
    • VariableKind
  • Attachmate.Verastream.HostIntegrator.ScriptAPI.Command
    • CheckOperationConditions
    • Command
    • DefaultValue
    • MoveCursor
    • Navigate
    • ReadFromMappedAttribute
    • ReadVariableFromAttribute
    • ReadVariableFromField
    • ReadVariableFromLocation
    • ReadVariableFromTerminal
    • ResetRecordSet
    • Transmit
    • TransmitTerminalKey
    • TransmitToAttribute
    • TransmitToField
    • TransmitToLocation
    • TransmitToOffset
    • UpdateAttribute
    • UpdateAttributes
    • UpdateRecordSetField
    • UpdateRecordSetFields
    • WaitForCommString
    • WaitForCondition
    • WaitForCursorAtAttribute
    • WaitForCursorAtLocation
    • WaitForCursorAtRecordSetField
    • WaitForCursorAtTerminalField
    • WaitForCursorNotAtLocation
    • WaitForCursorNotAtTerminalField
    • WaitForDisplayString
    • WaitForHostSilence
    • WaitForKeyboardEnabled
    • WaitForMultipleEvents
    • WaitForNewHostScreen
    • WaitForUpdate
    • WaitMS
    • WriteToMappedAttribute
    • WriteVariableToAttribute
    • WriteVariableToField
    • WriteVariableToLocation
    • WriteVariableToTerminal
  • WRQ.Verastream.HostIntegrator
    • RcConst

Interface IRecordSetMetaData

The methods and properties in the RecordSetMetaData class manage recordset metadata.

Inherited Members
IMetaData.Name
IMetaData.Description
IMetaData.MetaDataType
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
public interface IRecordSetMetaData : IMetaData
Remarks

The methods and properties in the RecordSetMetaData class manage recordset metadata.

Properties

FieldNames

Gets a list of the fields in a recordset.

Declaration
IList<string> FieldNames { get; }
Property Value
Type Description
IList<string>

This property returns a list of the fields in a recordset.

Remarks

Gets a list of the fields in a recordset.

ScrollOperations

Gets the available scroll operations for the record set.

Declaration
IDictionary<ScrollMovement, string> ScrollOperations { get; }
Property Value
Type Description
IDictionary<ScrollMovement, string>
Remarks

Gets the available scroll operations for the record set. The returned Dictionary object contains key-value pairs, where the key is a ScrollMovement object that contains a scroll operation type and the value is a String object containing the name of an entity operation.

SupportsDirectInserts

Gets whether the host allows direct insertion of records for a recordset.

Declaration
bool SupportsDirectInserts { get; }
Property Value
Type Description
bool

This property returns a boolean indicating whether the host allows direct insertion of records as part of a recordset.

Remarks

Gets whether the host allows direct insertion of records as part of a recordset.

SupportsSelect

Gets whether the host supports a select operation for a recordset.

Declaration
bool SupportsSelect { get; }
Property Value
Type Description
bool

This property returns a boolean indicating whether the host supports a select operation for a recordset.

Remarks

Gets whether the host supports a select operation for a recordset.

Methods

GetScrollOperation(ScrollMovement)

Gets the scroll operation for the specified scroll movement.

Declaration
string GetScrollOperation(ScrollMovement movement)
Parameters
Type Name Description
ScrollMovement movement

Specifies a scroll movement, in the form of a member of the ScrollMovement enumeration.

Returns
Type Description
string

This method returns the operation associated with the specified scroll movement.

Remarks

Gets the scroll operation for the specified scroll movement, in the context of the current recordset.

ToString()

Generates a string object that represents the current values of this IRecordSetMetaData object.

Declaration
string ToString()
Returns
Type Description
string

the string representation of this object

In This Article
Back to top © 1985-2024 Rocket Software, Inc. or its affiliates. All Rights Reserved