Extensions.File.CloseFile
Jump to navigation
Jump to search
Classification
Name | CloseFile |
Short Description | Closes the current file |
Class | Action |
Extension | OTX File extension |
Group | File related Actions |
Exceptions | FileSaveException InvalidReferenceException |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
File.CloseFile(FileHandleVariable handle);
Description
The CloseFile closes the current file and releases any resources associated with the current file. In the case of a FileWriteHandle, the file will be saved before closing. The use of CloseFile is optional. An OTX runtime system shall automatically close any open FileHandles at the end of a diagnostic session, saving the file in case of a FileWriteHandle.
If a diagnostic sequence uses a FileHandle after it has been closed by a CloseFile action, the runtime system shall throw an otx:InvalidReferenceException.
Properties
Name | Data Type | Class | Default | Cardinality | Description |
Handle | FileHandle | Variable | - | [1..1] | The handle for the file that the related file object encapsulates. |
OTL Examples
/// Local Declarations
File.FileReadHandle FileReadHandle;
/// Flow
FileReadHandle = File.OpenFileForRead("file:///D:/abc.txt", @Encoding:UTF-8);
File.CloseFile(FileReadHandle);
See also
DeleteDirectory
DeleteFile
SaveFile
WriteBytes
WriteFile
WriteLine