9.204 STM_FILE_CLOSE
This Built-In function closes the stream file which was previously opened by a STM_FILE_OPEN.
All stream files opened should be closed before terminating a function. Once the stream file is closed, no further action against that file is possible until it is re-opened.
Related Built-In Functions: STM_FILE_OPEN, STM_FILE_READ, STM_FILE_WRITE, STM_FILE_WRITE_CTL
Arguments
No | Type | Req/ Opt | Description | Min Len | Max Len | Min Dec | Max Dec |
|---|---|---|---|---|---|---|---|
1 | N | Req | File number (file handle) of the file that is to be closed. This number was allocated to a stream file and returned on the STM_FILE_OPEN. | 1 | 3 | 0 | 0 |
Return Values
No | Type | Req/ Opt | Description | Min Len | Max Len | Min Dec | Max Dec |
|---|---|---|---|---|---|---|---|
1 | A | Opt | Return Code OK = File has been closed ER = Error occurred. | 2 | 2 |
Example
Refer to 9.205 STM_FILE_OPEN.