Engine Help Category: OSFile
Filtered overview of the Engine Help documentation.
@AttachOSFileToNote
Attaches to the document with the NOTEHANDLE NOTEHANDLE1 the files whose OSPATH(s) are specified in the TEXT/TEXTLISTE TEXT1/TEXTLIST1. If a TEXT/TEXTLIST TEXT2/TEXTLIST2 is specified, the file attachments are named afte …
@CallIDF
Calls an IDF document with the TEXT IDFNAME1 as sub-processing. The file with the OSPATH OSPATH2 is imported. ACHTUNG: Local variables from the main processing are not accessible in the program called by @CallIDF, and vi …
@CheckHandle
Checks whether VIEWHANDLE/NOTEHANDLE/DBHANDLE/FILEHANDLE... VIEWHANDLE1/NOTEHANDLE1/DBHANDLE1/FILEHANDLE1... is an open handle. If yes, TRUE returned, otherwise FALSE. FILEHANDLE can only be checked as of version 1.93.
@CloseOSFile
Closes the OSFILE with the FILEHANDLE FILEHANDLE1 and returns the closed FILEHANDLE.
@CreateOSDirectory
Syntax 1: Creates a directory with the OSPATH OSPATH1. Syntax 2: Creates the directories specified in the OSPATHLIST OSPATHLIST1 are specified.
@DeleteOSDirectory
Syntax 1: Deletes the directory with OSPATH OSPATH1. Syntax 2: Deletes the directories specified in the OSPATHLIST OSPATHLIST1 are specified. A directory must be empty before it can be deleted.
@DeleteOSFile
Syntax 1: Deletes the file with OSPATH OSPATH1. Syntax 2: Deletes the files specified in the OSPATHLIST OSPATHLIST1 are specified. A NUMBERLIST is returned; at each corresponding position parallel to TEXT1/TEXTLIST1, 1 i …
@ExtractOSFileFromNote
Copies one or more file attachments, whose names or positions (see @AttachmentInfo) in TEXT/TEXTLIST/FN/FNLIST TEXT1/TEXTLIST1/FN1/FNLIST1 are specified, from the document with the NOTEHANDLE NOTEHANDLE1 as files to a dr …
@FileLength
Returns the size of the file with the OSPATH OSPATH1.
@FTPNTGetFile
Retrieves the file with the name TEXT TEXTREMOTENAME from the current directory on the FTP server of the FTP session with the FTPNTHANDLE FTPNTHANDLE. TEXT TEXTREMOTENAME can also be a fully qualified path or a relative …
@GetOSFileCreated
Returns the creation time of one OS file (OSPATH1) or multiple OS files (OSPATHLIST1). A TDLIST is returned. At the position where the OS path of the file appears in OSPATHLIST1, the list contains the TD value for the cr …
@GetOSFileModified
Returns the time of the last modification of one OS file (OSPATH1) or multiple OS files (OSPATHLIST1). A TDLIST is returned. At the position where the OS path of the file appears in OSPATHLIST1, the list contains the TD …
@GetOSPath
Returns the physical/local path (OSPATH) for the relative NOTESPATH/NOTESPATHLIST NOTESPATH1/NOTESPATHLIST1. Directory and database links are taken into account. If a NOTESPATHLIST is passed as the input parameter, error …
@GetPosOSFile
Returns the current position in the OSFILE with the FILEHANDLE FILEHANDLE1.
@OpenOSFile
Opens the OSFILE with the OSPATH OSPATH1 und outputs einen FILEHANDLE for it. TEXT MODE2 can be used to specify the open mode. MODE2: A=(Append) Open for appending data B=(Binary) No conversion from CR to CRLF or vic …
@ReadOSFile
Reads a record of length FN LENGTH3 from the OS file identified by FILEHANDLE FILEHANDLE1. This record is returned as a variable of the data type specified in TEXT RETTYPE2. If TEXT/TEXTLIST TEXT3/TEXTLIST3 is specified, …
@ReadVarOSFile
Reads a variable from the OSFILE identified by FILEHANDLE FILEHANDLE1. The variable must have been written using @WriteVarOSFile, and is returned as the @Function result. The contents of a variable, including its name an …
@ScanOSDirectory
Scans a directory for the files it contains. In TEXT OSMATCHPATH specifies the OS path with the search criteria (wildcards...). In TEXT OPTIONS1 can be used to specify the file attributes that the files to be searched ma …
@SetPosOSFile
Sets the position in the OSFILE with FILEHANDLE FILEHANDLE1 to the values specified in FN POSITION2 (in bytes), taking into account mode TEXT MODE3. MODE3: S=Calculated from the start of the OSFILE C=Current position + P …
@WriteOSFile
Writes the contents of TEXT/FN/TD TEXT2/FN2/TD2 to the OSFILE identified by FILEHANDLE FILEHANDLE1. If the operation was successful, 1 (NUMBER) is returned. The optional parameter TEXT TEXTWRITETYPE3 specifies the write …
@WriteVarOSFile
Writes the complete representation of the variable VAR, including all associated metadata, in binary form to the OSFILE identified by the FILEHANDLE FILEHANDLE1. If the operation is successful, 1 (NUMBER) is returned. A …