Interface IAttributeMetaData
Provides metadata about an attribute that is defined on an entity of a Host Integrator model.
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
public interface IAttributeMetaData : IMetaDataProperties
IsReadable
Gets whether an attribute is readable.
Declaration
bool IsReadable { get; }Property Value
| Type | Description |
|---|---|
| bool | Gets whether an attribute is readable. |
Remarks
Gets whether an attribute is readable.
IsWriteable
Gets whether an attribute is writeable.
Declaration
bool IsWriteable { get; }Property Value
| Type | Description |
|---|---|
| bool | Gets whether an attribute is writeable. |
Remarks
Gets whether an attribute is writeable.
Length
Gets the length of an attribute--that is, the total number of screen characters.
Declaration
int Length { get; }Property Value
| Type | Description |
|---|---|
| int | Gets the length of an attribute--that is, the total number of screen characters. |
Remarks
Gets the length of an attribute--that is, the total number of screen characters.
ReadVariable
Gets the name of the variable mapped to this attribute for reading.
Declaration
string ReadVariable { get; }Property Value
| Type | Description |
|---|---|
| string | Gets the name of the variable mapped to this attribute for reading. |
Remarks
This variable will be updated with the attribute value when an entity operation performs a ReadFromMappedAttr command. Returns a 0-length string if the attribute is not mapped.
TerminalAttributesEnabled
Gets whether the terminal attributes are enabled for an attribute.
Declaration
bool TerminalAttributesEnabled { get; }Property Value
| Type | Description |
|---|---|
| bool | Gets whether the terminal attributes are enabled for an attribute. |
Remarks
Gets whether the terminal attributes are enabled for an attribute.
WriteVariable
Gets the name of the variable mapped to this attribute for writing.
Declaration
string WriteVariable { get; }Property Value
| Type | Description |
|---|---|
| string | Gets the name of the variable mapped to this attribute for writing. |
Remarks
The attribute will be updated with the value from this variable when an entity operation performs a WriteToMappedAttr command.
Methods
ToString()
Generates a string object that represents the current values of this IAttributeMetaData object.
Declaration
string ToString()Returns
| Type | Description |
|---|---|
| string | the string representation of this object |