OpenAccessFile class | QSYS API Reference Guide
Estimated reading time: 4 minutes
Provides the facilities to use a display file without prior infrastructure.
Namespace: ASNA.QSys.Runtime.JobSupport Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object
Constructors
| Name | Description |
|---|---|
| OpenAccessFile(String) | Initializes a new instance of the OpenAccessFile class for the razor display page. |
OpenAccessFile(String)
Initializes a new instance of the OpenAccessFile class for the razor display page.
OpenAccessFile(String)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | displayFilePath | Route to the razor display page. |
Properties
| Type | Name | Description |
|---|---|---|
| DataSet | DataSet | Gets the dataset containing the data for the records of the display file. |
| Byte | FeedbackAID | Gets or sets the device’s attention identifier (AID) key pressed. |
| Int16 | FeedbackCursor | Gets or sets the device’s cursor position. |
| String | FeedbackField | Gets or set the name of the field where the cursor was position when the AID key was pressed. |
| Int16 | FeedbackLowestSubfile | Gets or sets the subfile record number on first record displayed on the screen when the AID key was pressed. |
| Int16 | FeedbackSubfileCursorRRN | Gets or sets the subfile record number where the cursor was position when the AID key was pressed. |
| String | LibraryNameFound | Gets the library where file was found. |
| Int32 | OpenAccessFileID | Unique file identifier. |
Methods
| Signature | Description |
|---|---|
| ClearRecords(String) | Clears all the data from a record format’s buffer. |
| Close() | Closes the display file disposing of its resources. |
| Dispose(Boolean) | Closes the file and releases the resources used by the current instance of the OpenAccessFile class. |
| Dispose() | Closes the file and releases the resources used by the current instance of the OpenAccessFile class. |
| Extend(String, Char[], Action<String, DataRow, Object>, Object) | Adds a record to the record format’s buffer. |
| Open() | Opens the display file for IO operations, allocating the dataset buffer for the file’s records. |
| Read() | Presents the current data on the device and waits for the user to enter new data. |
| Write(String, Char[], Action<String, DataRow, Object>, Object) | Adds a record to the record format’s buffer. |
void ClearRecords(string formatName)
Clears all the data from a record format’s buffer.
void ClearRecords(string formatName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | The name of the record format to clear. |
void Close()
Closes the display file disposing of its resources.
void Close()
void Dispose(bool disposing)
Closes the file and releases the resources used by the current instance of the OpenAccessFile class.
void Dispose(bool disposing)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Boolean | disposing | true to perfom the closing and releasing. |
void Dispose()
Closes the file and releases the resources used by the current instance of the OpenAccessFile class.
void Dispose()
void Extend(string formatName, Char[] optionIndicators, Action<string, DataRow, object> populateBuffer, object popCookie)
Adds a record to the record format’s buffer.
void Extend(string formatName, Char[] optionIndicators, Action<string, DataRow, object> populateBuffer, object popCookie)
int Open()
Opens the display file for IO operations, allocating the dataset buffer for the file’s records.
int Open()
void Read()
Presents the current data on the device and waits for the user to enter new data.
void Read()
void Write(string formatName, Char[] optionIndicators, Action<string, DataRow, object> populateBuffer, object popCookie)
Adds a record to the record format’s buffer.
void Write(string formatName, Char[] optionIndicators, Action<string, DataRow, object> populateBuffer, object popCookie)