fSaveText (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Functions for managing external files

fSaveText

Presentation

Example

Operating mode in Windows Vista (and later)

Equivalence

See also

fSaveText (Function)

In french: fSauveTexte

Creates and fills a text file with the content of a text control or text variable (string variable, edit control in a window, Static control in a report, ...). If the file already exists, it is deleted then re-created.

Remarks:

The strings containing binary "0" ("\0") are supported.
The created text file is always in ANSI format, regardless of the platform used (PC, Pocket PC, ...). To create a text file in Unicode format on a Pocket PC, use fOpen or fCreate (see the notes).

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 16 and later

This function is now available for Windows Phone applications.

New in version 16

This function is now available for Windows Phone applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

// Fills the file with the content of a variable
MyTextString is string = "This is a test" + CR + "Using fSaveText"
fSaveText("C:\Temp\MyFile.txt", MyTextString)

// Fills the file with the content of a control
// EDT_LASTN_FIRSTN is an edit control
fSaveText("C:\Customers\LastFirstName.txt", EDT_LASTN_FIRSTN)

// Performs a file copy by replacing "Franc" by "Euro"
FileContent is string
FileContent = fLoadText("C:\Sales\FrancPrices.txt")
FileContent = Replace(FileContent, "Franc", "Euro")
fSaveText("C:\Sales\EuroPrices.txt", FileContent)

// Fills the file with the content of a variable
MyTextString is string = "This is a test" + CR + "Using fSaveText"
fSaveText("\Temp\MyFile.txt", MyTextString)

// Fills the file with the content of a control
// EDT_LASTN_FIRSTN is an edit control
fSaveText("\Customers\LastFirstName.txt", EDT_LASTN_FIRSTN)

// Performs a file copy by replacing "Franc" by "Euro"
FileContent is string
FileContent = fLoadText("\Sales\FrancPrices.txt")
FileContent = Replace(FileContent, "Franc", "Euro")
fSaveText("\Sales\EuroPrices.txt", FileContent)

Syntax

<Result> = fSaveText(<Name and path of the text file> , <Content>)

<Result>: Boolean

True if the operation was successful,
False otherwise. To find out the error details, use ErrorInfo associated with the errMessage constant.

<Name and path of the text file>: Character string (with quotes)

Name and full (or relative) path of text file to create. A UNC path can be used.
Versions 15 and later
This parameter can be in Ansi or Unicode format.
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its subdirectories, as well as onto the external memory (SDCard).
New in version 15
This parameter can be in Ansi or Unicode format.
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its subdirectories, as well as onto the external memory (SDCard).
This parameter can be in Ansi or Unicode format.
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its subdirectories, as well as onto the external memory (SDCard).
This path must be a full path or a UNC path. It cannot be a relative path.
Versions 16 and later
Windows Phone: The file path corresponds to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the files found in the data directory associated with the application can be handled.
New in version 16
Windows Phone: The file path corresponds to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the files found in the data directory associated with the application can be handled.
Windows Phone: The file path corresponds to a relative path in relation to the current directory. The current directory corresponds to the data directory of application.
Reminder: Only the files found in the data directory associated with the application can be handled.
Versions 17 and later
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its subdirectories.
New in version 17
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its subdirectories.
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its subdirectories.

<Content>: Character string (with quotes)

String containing the content of the file.

Remarks

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).

Indeed, in Windows Vista (and later), with the UAC mechanism (User Account Control) enabled, you must have the administrator privileges to handle and/or modify the files or directories in the 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 into the Windows directory or into the "Program Files" directory,
use the system directory corresponding to the application (returned by SysDir associated with the srCommonAppData constant).

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.

Equivalence

fSaveText is equivalent to the following code:

// Opens the file in read-only
f is int = fOpen("C:\MyFile.txt", foCreate)
// Writes into the file
FileContent is string = "example of text"
fWrite(f, FileContent)
// Closes the file
fClose(f)

Equivalence

fSaveText is equivalent to the following code:

// Opens the file in read-only
f is int = fOpen("\MyFile.txt", foCreate)
// Writes into the file
FileContent is string = "example of text"
fWrite(f, FileContent, Length(FileContent)*2)
// Closes the file
fClose(f)

Remark: The text file created by fOpen or fCreate on a Pocket PC is in Unicode format. The text file created by fSaveText on a Pocket PC is a file in ANSI format.

Component : wd240std.dll