WorkstationFileBase class | QSYS API Reference Guide
Estimated reading time: 18 minutes
Base class for Workstation files. It contains functionality to support common input/output operations on Workstation files.
Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object –> FileBase
Constructors
| Name | Description |
|---|---|
| WorkstationFileBase(String, String, Boolean) | Initializes a new instance of the WorkstationFileBase class. |
| WorkstationFileBase(String, String, Boolean, Action) | Initializes a new instance of the WorkstationFileBase class. |
WorkstationFileBase(String, String, Boolean)
Initializes a new instance of the WorkstationFileBase class.
WorkstationFileBase(String, String, Boolean)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | dclWorkstationFileName | Field name for this file in the program. |
| String | filePath | Path to the file in the Database, given as “library/filename”. |
| Boolean | shareOpenDataPath | True to indicate that the file can be shared with other programs; otherwise false. |
WorkstationFileBase(String, String, Boolean, Action)
Initializes a new instance of the WorkstationFileBase class.
WorkstationFileBase(String, String, Boolean, Action)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | dclWorkstationFileName | Field name for this file in the program. |
| String | filePath | Path to the file in the Database, given as “library/filename”. |
| Boolean | shareOpenDataPath | True to indicate that the file can be shared with other programs; otherwise false. |
| Action | infSR | Method called when there is an error in a file operation. |
Properties
| Type | Name | Description |
|---|---|---|
| Int16 | DisplayFileSubfileCursorRRN | Gets the subfile record number where the cursor was position when the AID key was pressed. |
| Int16 | FeedbackActiveWindowCursor | Gets the display file feedback active window cursor position. |
| Int16 | FeedbackActiveWindowCursorCol | Gets the display file feedback active window cursor column. |
| Int16 | FeedbackActiveWindowCursorRow | Gets the display file feedback active window cursor row. |
| Byte | FeedbackAID | Gets the display file feedback attention identifier. |
| Int16 | FeedbackCursor | Gets the display file feedback cursor position. |
| Int16 | FeedbackCursorCol | Gets the display file feedback cursor column. |
| Int16 | FeedbackCursorRow | Gets the display file feedback cursor row. |
| String | FeedbackField | Gets the diaplsy file feedback last field name where cursor was positioned. |
| Int16 | FeedbackFlags | Gets the display file feedback flags. |
| Int16 | FeedbackLowestSubfile | Gets the display file feedback lowest visible subfile relative record number. |
| Int32 | FeedbackSubfileRecords | Gets the count of subfile records. |
| String | FilePath | Gets or sets the path to the file in the Database, given as “library/filename”. |
| String | FormatName | Gets the last-used record format name. |
| Boolean | INKA | F1 |
| Boolean | INKB | F2 |
| Boolean | INKC | F3 |
| Boolean | INKD | F4 |
| Boolean | INKE | F5 |
| Boolean | INKF | F6 |
| Boolean | INKG | F7 |
| Boolean | INKH | F8 |
| Boolean | INKI | F9 |
| Boolean | INKJ | F10 |
| Boolean | INKK | F11 |
| Boolean | INKL | F12 |
| Boolean | INKM | F13 |
| Boolean | INKN | F14 |
| Boolean | INKP | F15 |
| Boolean | INKQ | F16 |
| Boolean | INKR | F17 |
| Boolean | INKS | F18 |
| Boolean | INKT | F19 |
| Boolean | INKU | F20 |
| Boolean | INKV | F21 |
| Boolean | INKW | F22 |
| Boolean | INKX | F23 |
| Boolean | INKY | F24 |
| Int32 | SflRRN | Gets the relative record number (1-based) of the last Subfile operation. |
| Boolean | ShareOpenDataPath | Gets or sets a value to indicate that the file can be shared with other programs. |
| String | StarDirectionIn | String with the value “I” |
| String | StarDirectionInAttn | String with the value “N” |
| String | StarDirectionNotActive | String with the value “X” |
| String | StarDirectionOut | String with the value “O” |
| String | StarDirectionRead | String with the value “R” |
| String | StarDirectionReadAttn | String with the value “A” |
| String | StarDirectionVoid | String with the value “V” |
| String | StarDirFieldName | String with the value “*Direction” |
| String | StarOptionIndFieldName | String with the value “*Indicators” |
| String | StarResponseIndFieldName | String with the value “*ResponseIndicators” |
Methods
| Signature | Description |
|---|---|
| attachBuffer(AdgDataSet) | When overriden in a derived class, set this file’s DataSet to the given AdgDataSet. |
| chainKey(String, AdgKeyTable, Boolean) | Executes CHAIN by search Key override. Throws: CHAIN not supported on WorkstationFiles Exception. |
| chainKey(String, AdgKeyTable, Boolean, IDS) | Executes CHAIN by search Key override. Throws: CHAIN not supported on WorkstationFiles Exception. |
| chainRRN(String, Int32, IDS) | Executes CHAIN by Relative Record Number. |
| chainRRN(String, Int32, Char[]) | Executes CHAIN by Relative Record Number. |
| chainRRN(String, Int32, Boolean) | For backwards compatibility with programs compiled prior to v12.0 |
| chainRRN(String, Int32, Boolean, IDS) | Executes CHAIN by Relative Record Number override. (Not implemented). |
| ChainRRN(String, Int32, IDS) | Executes CHAIN by Relative Record Number. |
| ChainRRN(String, Int32, Char[]) | Executes CHAIN by Relative Record Number. |
| close() | Closes Workstation file. |
| deleteByRRN(String, Int32) | Executes DELETE by Relative Record Number. |
| exFmt(String, IDS) | Executes EXFMT operation. |
| exFmt(String, Char[]) | Executes EXFMT operation. |
| ExFmt(String, IDS) | Executes EXFMT operation. |
| ExFmt(String, Char[]) | Executes EXFMT operation. |
| insert(String, Int32) | Insert a row in the current record. |
| open() | Opens Workstation File. |
| Open() | Opens Workstation File. |
| read(String, IDS) | Executes READ operation. |
| read(String, Char[]) | Executes READ operation. |
| Read(String, IDS) | Executes READ operation. |
| Read(String, Char[]) | Executes READ operation. |
| readNextChanged(String, Int32, IDS) | Executes Workstationfile READ NEXT record CHANGED operation. |
| readNextChanged(String, Int32, Char[]) | Executes Workstationfile READ NEXT record CHANGED operation. |
| ReadNextChanged(String, Int32, IDS) | Executes Workstationfile READ NEXT record CHANGED operation. |
| ReadNextChanged(String, Int32, Char[]) | Executes Workstationfile READ NEXT record CHANGED operation. |
| update(String, Char[]) | Execute UPDATE subfile record operation. |
| updateFlds(String, String[]) | Execute UPDATE FIELDS operation. |
| write(String, Char[]) | Executes WRITE record operation. |
| write(String, Char[], IDS) | Executes WRITE record operation. |
| writeSubfile(String, Int32, Char[]) | Write a subfile record. |
void attachBuffer(AdgDataSet adgDataSet)
When overriden in a derived class, set this file’s DataSet to the given AdgDataSet.
void attachBuffer(AdgDataSet adgDataSet)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| AdgDataSet | adgDataSet | The dataset to attach. |
void chainKey(string formatName, AdgKeyTable key, bool noLock)
Executes CHAIN by search Key override. Throws: CHAIN not supported on WorkstationFiles Exception.
void chainKey(string formatName, AdgKeyTable key, bool noLock)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Not used. |
| AdgKeyTable | key | Not used. |
| Boolean | noLock | Not used. |
void chainKey(string formatName, AdgKeyTable key, bool noLock, IDS ds)
Executes CHAIN by search Key override. Throws: CHAIN not supported on WorkstationFiles Exception.
void chainKey(string formatName, AdgKeyTable key, bool noLock, IDS ds)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Not used. |
| AdgKeyTable | key | Not used. |
| Boolean | noLock | Not used. |
| IDS | ds | Not used. |
void chainRRN(string formatName, int rrn, IDS indDS)
Executes CHAIN by Relative Record Number.
void chainRRN(string formatName, int rrn, IDS indDS)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| Int32 | rrn | Relative Record Number. |
| IDS | indDS | Indicator Data Structure |
void chainRRN(string formatName, int rrn, Char[] indicators)
Executes CHAIN by Relative Record Number.
void chainRRN(string formatName, int rrn, Char[] indicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| Int32 | rrn | Relative Record Number. |
| Char[] | indicators | Indicator collection. |
void chainRRN(string formatName, int rrn, bool noLock)
For backwards compatibility with programs compiled prior to v12.0
void chainRRN(string formatName, int rrn, bool noLock)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| Int32 | rrn | Relative Record Number. |
| Boolean | noLock | Not used. |
void chainRRN(string formatName, int rrn, bool noLock, IDS intoDS)
Executes CHAIN by Relative Record Number override. (Not implemented).
void chainRRN(string formatName, int rrn, bool noLock, IDS intoDS)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| Int32 | rrn | Relative Record Number. |
| Boolean | noLock | True if locking should be performed. |
| IDS | intoDS | IDS object that receives the data read. |
void ChainRRN(string formatName, int rrn, IDS indDS)
Executes CHAIN by Relative Record Number.
void ChainRRN(string formatName, int rrn, IDS indDS)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| Int32 | rrn | Relative Record Number. |
| IDS | indDS | Indicator Data Structure. |
void ChainRRN(string formatName, int rrn, Char[] indicators)
Executes CHAIN by Relative Record Number.
void ChainRRN(string formatName, int rrn, Char[] indicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| Int32 | rrn | Relative Record Number. |
| Char[] | indicators | Indicator collection. |
void close()
Closes Workstation file.
void close()
void deleteByRRN(string formatName, int rrn)
Executes DELETE by Relative Record Number.
void deleteByRRN(string formatName, int rrn)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Format name. |
| Int32 | rrn | Relative Record Number. |
void exFmt(string formatName, IDS indDS)
Executes EXFMT operation.
void exFmt(string formatName, IDS indDS)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| IDS | indDS | Output Indicator Data Structure. |
void exFmt(string formatName, Char[] optionIndicators)
Executes EXFMT operation.
void exFmt(string formatName, Char[] optionIndicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| Char[] | optionIndicators | Option indicator collection. |
void ExFmt(string formatName, IDS indDS)
Executes EXFMT operation.
void ExFmt(string formatName, IDS indDS)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| IDS | indDS | Indicator Data Structure. |
void ExFmt(string formatName, Char[] optionIndicators)
Executes EXFMT operation.
void ExFmt(string formatName, Char[] optionIndicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| Char[] | optionIndicators | Option indicator collection. |
void insert(string formatName, int rrn)
Insert a row in the current record.
void insert(string formatName, int rrn)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Name of the record format. |
| Int32 | rrn | Relative record number. |
void open()
Opens Workstation File.
void open()
void Open()
Opens Workstation File.
void Open()
void read(string formatName, IDS indDS)
Executes READ operation.
void read(string formatName, IDS indDS)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| IDS | indDS | Indicator Data Structure. |
void read(string formatName, Char[] indicators)
Executes READ operation.
void read(string formatName, Char[] indicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| Char[] | indicators | Option indicator collection. |
void Read(string formatName, IDS indDS)
Executes READ operation.
void Read(string formatName, IDS indDS)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| IDS | indDS | Indicator Data Structure. |
void Read(string formatName, Char[] indicators)
Executes READ operation.
void Read(string formatName, Char[] indicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| Char[] | indicators | Option indicator collection. |
int readNextChanged(string formatName, int originalRRN, IDS indDS)
Executes Workstationfile READ NEXT record CHANGED operation.
int readNextChanged(string formatName, int originalRRN, IDS indDS)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Input record format name. |
| Int32 | originalRRN | Input original Relative Record Number. |
| IDS | indDS | Input Indicator Data Structure reference. |
Returns
| Type | Description |
|---|---|
| Int32 | If record exists Relative Record Number for record that changed, otherwise original RRN. |
int readNextChanged(string formatName, int originalRRN, Char[] indicators)
Executes Workstationfile READ NEXT record CHANGED operation.
int readNextChanged(string formatName, int originalRRN, Char[] indicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Input record format name. |
| Int32 | originalRRN | Input original Relative Record Number. |
| Char[] | indicators | Input option indicators. |
Returns
| Type | Description |
|---|---|
| Int32 | If record exists Relative Record Number for record that changed, otherwise original RRN. |
int ReadNextChanged(string formatName, int originalRRN, IDS indDS)
Executes Workstationfile READ NEXT record CHANGED operation.
int ReadNextChanged(string formatName, int originalRRN, IDS indDS)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Input record format name. |
| Int32 | originalRRN | Input original Relative Record Number. |
| IDS | indDS | Input Indicator Data Structure reference. |
Returns
| Type | Description |
|---|---|
| Int32 | If record exists Relative Record Number for record that changed, otherwise exception is thrown. |
int ReadNextChanged(string formatName, int originalRRN, Char[] indicators)
Executes Workstationfile READ NEXT record CHANGED operation.
int ReadNextChanged(string formatName, int originalRRN, Char[] indicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Input record format name. |
| Int32 | originalRRN | Input original Relative Record Number. |
| Char[] | indicators | Input option indicators. |
Returns
| Type | Description |
|---|---|
| Int32 | If record exists Relative Record Number for record that changed, otherwise throws exception. |
void update(string formatName, Char[] optionIndicators)
Execute UPDATE subfile record operation.
void update(string formatName, Char[] optionIndicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| Char[] | optionIndicators | Option indicators. |
void updateFlds(string formatName, String[] fieldNames)
Execute UPDATE FIELDS operation.
void updateFlds(string formatName, String[] fieldNames)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name. |
| String[] | fieldNames | Collection of field names. |
void write(string formatName, Char[] optionIndicators)
Executes WRITE record operation.
void write(string formatName, Char[] optionIndicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name/ |
| Char[] | optionIndicators | Option indicator collection. |
void write(string formatName, Char[] optionIndicators, IDS fromDS)
Executes WRITE record operation.
void write(string formatName, Char[] optionIndicators, IDS fromDS)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Record format name/ |
| Char[] | optionIndicators | Option indicator collection. |
| IDS | fromDS | Input data from Data Structure. |
void writeSubfile(string formatName, int rrn, Char[] optionIndicators)
Write a subfile record.
void writeSubfile(string formatName, int rrn, Char[] optionIndicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Name of the record format to write. |
| Int32 | rrn | Relative record number. |
| Char[] | optionIndicators | Indicator array to use in the write operation. |