Interface IFieldMetaData

The methods and properties in the FieldMetaData class manage fields.

Inherited Members

IMetaData.Name

IMetaData.Description

IMetaData.MetaDataType

Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI

Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll

Syntax

public interface IFieldMetaData : IMetaData

Remarks

The methods and properties in the FieldMetaData class manage fields.

Properties

IsKey

Gets the key flag for a field.

Declaration

bool IsKey { get; }

Property Value

Type	Description
bool	true if the field is a key

Remarks

This property indicates if this recordset field is designated as a Key value. A key value is unique for the associated field in the recordset--no other records will have the same value for that field.

IsReadable

Gets the readable flag for a field.

Declaration

bool IsReadable { get; }

Property Value

Type	Description
bool	true if the field value can be read

Remarks

Gets the readable flag for a field, which indicates whether the field can be read by a client.

IsWriteable

Gets the writeable flag for a field.

Declaration

bool IsWriteable { get; }

Property Value

Type	Description
bool	boolean true if the field can be updated

Remarks

Gets the writeable flag for a field, which indicates whether Host Integrator allows this field to have data written to it.

Length

Gets the length of a field.

Declaration

int Length { get; }

Property Value

Type	Description
int	the length of the field

Remarks

If the returned value is -1, the length of the field is variable.

TerminalAttributesEnabled

Gets the terminal attributes enabled flag for a field.

Declaration

bool TerminalAttributesEnabled { get; }

Property Value

Type	Description
bool	true if a TerminalAttributes object will be returned for this field; when the session has set enabledTerminalAttributes(true)

Remarks

Gets the flag for the field that specifies whether terminal attributes are enabled. The terminal attributes enabled flag indicates whether Host Integrator can return the terminal attributes of the field. Terminal attributes specify various properties the text can have, including color, whether the text is blinking, and whether the text is displayed in reverse video.

Methods

ToString()

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

Declaration

string ToString()

Returns

Type	Description
string	the string representation of this object