PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN

WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Writes a line into an external file. The characters required to go to the next line are automatically inserted at the end of the added line.
PHP Only the ANSI format is supported.
WINDEVWEBDEV - Server codeReports and QueriesJavaUser code (UMC)PHPAjax
// Open an external file
FileID = fOpen("C:\MyDirectories\File.txt", foReadWrite)
IF FileID <> -1 THEN
// Write a line into this file
ResWrite = fWriteLine(FileID, "Meeting report")
IF ResWrite = False THEN
...
END
END
New in version 28
WINDEVWEBDEV - Server codeReports and QueriesJavaUser code (UMC)Ajax
// Open an external file
MyFile is DiskFile
MyFile = fOpen("C:\MyDirectories\File.txt", foReadWrite)
IF NOT ErrorOccurred THEN
// Write a line into this file
ResWrite = fWriteLine(FileID, "Meeting report")
IF ResWrite = False THEN
...
END
END
Syntax

Writing a line into an external file Hide the details

<Result> = fWriteLine(<File used> , <Line to write>)
<Result>: Boolean
  • True if the write operation was performed into the specified file,
  • False if an error occurs. To get more details on the error, use ErrorInfo with the errMessage constant.
<File used>: Integer or DiskFile variable
PHP This parameter must be a variant.
<Line to write>: Character string
Line that must be written into the file (up to 2GB).
WINDEVWEBDEV - Server codeReports and QueriesAndroidAndroid Widget JavaUser code (UMC)Ajax

Writing a fixed-length line into an external file (speeds up the write operation) Hide the details

<Result> = fWriteLine(<File used> , <Address of line to write> , <Size to write>)
<Result>: Boolean
  • True if the write operation was performed into the specified file,
  • False if an error occurs. To get more details on the error, use ErrorInfo with the errMessage constant.
<File used>: Integer or DiskFile variable
<Address of line to write>: Address
Address of the line that must be written into the file.
<Size to write>: Integer
Size in bytes (characters) of the line that must be written (up to 2GB).
This parameter must be less than or equal to the real size of the wine written into the external file. For example, if the size of the line to write is equal to 100 bytes, <Size to write> must be less than or equal to 100 bytes.
If this parameter is less than the real size of the written line, only the specified number of bytes will be written into the text file. The line will be truncated.
Remarks

Handling errors

fWriteLine throws an error in the following cases:
  • the file is not opened,
  • the file is not accessible in write mode,
  • the file is locked by another computer or by another application,
  • no disk space is available.
Caution: fWriteLine can only be used on text files. This function does not support the binary 0 (the write operation is stopped).
WINDEVWEBDEV - Server codeReports and QueriesUser code (UMC)

Operating mode in Windows Vista (and later)

If this function does not operate properly in Windows Vista (and later), check whether the file or directory used is not in one of the system directories (Windows directory or "Program Files" directory).
In Windows Vista (and later), with the UAC mechanism (User Account Control) enabled, you must have administrator privileges to handle and/or modify the files or directories in system directories (Windows directory or "Program Files" directory).
Programming tip: To handle and/or modify the files or directories without administrator privileges, you should:
  • avoid writing to the Windows directory or to the "Program Files" directory,
  • use the system directory of the application (returned by SysDir with the srAppDataCommun constant, for example).
Remark: In Windows Vista (and later), the virtualization mechanism is used to make the applications compatible with Vista. If the file is created in a system directory without having sufficient rights, this file will actually be created in another directory (C:\Users\<LOGIN>AppData\Local\VirtualStore\Windows\). In this case, the file cannot be shared between several applications.

Position in the file

When opening a file, the current position corresponds to:
  • the first file byte (by default),
  • the last byte of the file is the file is opened in "addition" mode (foAdd constant).
This position can be modified by fSeek.
fWriteLine writes the specified elements from the current position. Once fWriteLine has been executed, the current position is set to the last byte written.

Managing the ANSI/UNICODE format

fWriteLine is used to write:
  • a Unicode string in a Unicode file.
  • an Ansi string in an Ansi file.
The file is created or opened with fCreate/fOpen by specifying the file type.
Remarks:
  • The size to write into Unicode file a must be multiplied by two compared to an ANSI file.
  • If a character string in ANSI format is written into a UNICODE file (and conversely), the conversion will be implicitly performed.
    Format of the string passed as parameter
    External file
    in ANSI format
    (fOpen or fCreate associated with the foAnsi constant)
    External file
    in UNICODE format
    (fOpen or fCreate associated with the foUnicode constant)
    fWriteLine functionANSINo conversion is required before the write operationAutomatic conversion of the string before the write operation
    UNICODEAutomatic conversion of the string before the write operationNo conversion is required before the write operation
In WINDEV and WEBDEV projects, if the "Use ANSI strings at runtime" option is enabled in the project configuration description, the default opening mode is foAnsi (1st column).
In WINDEV and WEBDEV projects, if the "Use UNICODE strings at runtime" option is enabled in the project configuration description, the default opening mode is foUnicode (second column).
In the WINDEV Mobile projects, regardless of the version and mode, the opening mode used by default is foUnicode (second column).
For more details, see Managing UNICODE
Related Examples:
Handling text files Unit examples (WINDEV): Handling text files
[ + ] Handling "text" files with WINDEV:
- Create a text file
- Write into a text file
- Read in a text file
Handling text files Unit examples (WEBDEV): Handling text files
[ + ] This example explains how to handle "non HFSQL" files with WEBDEV and it allows you to:
- Create a text file
- Write into a text file
- Read in a text file
Handling text files Unit examples (WINDEV Mobile): Handling text files
[ + ] Handling external "text" files:
- Create a text file
- Write into a text file
- Read in a text file
The TableTo functions Unit examples (WINDEV): The TableTo functions
[ + ] Exporting table data with the WLanguage functions.
The following topics are presented in this example:
1/ interfacing with Word and Excel
2/ sending data to the clipboard
3/ generating a text file
This example explains how to export the content of a table to a Word document, an Excel workbook, the clipboard or a text file via the following WLanguage functions: TableToWord, TableToExcel, ToClipboard, TableToText.
Business / UI classification: Business Logic
Component: wd280std.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment