WriteString

WriteString()

Syntax

Result = WriteString(#File, Text$ [, Format])

Description

Write a string to a file.

Parameters

#File The file to write to.

Text$ The string to write.
Format (optional)
The format in which to write the string. It can be one of the following values:
  #PB_Ascii  : Writes the string in ASCII format
  #PB_UTF8   : Writes the string in UTF8 format
  #PB_Unicode: Writes the string in UTF16 format
If this parameter is not specified, the string will be written in UTF8 format if the program is compiled in unicode mode and in ASCII format otherwise.

Return value

Returns nonzero if the operation was successful and zero if it failed.

Remarks

Because of file buffering, this function may return successful even if there is not enough space left on the output device for the write operation. The file must be opened using a write-capable function (i.e. not with ReadFile()). The null ending string character is not written to the file.

To place a BOM (byte order mark) to later identify the string encoding format of a file use the WriteStringFormat() function. To write a string including a newline sequence, use the WriteStringN() function.

For an example see the CreateFile() function.

See Also

ReadString(), WriteStringN(), WriteStringFormat(), CreateFile(), OpenFile()

Supported OS

All

<- WriteQuad() - File Index - WriteStringFormat() ->

#File	The file to write to.
Text$	The string to write.
Format (optional)	The format in which to write the string. It can be one of the following values: #PB_Ascii : Writes the string in ASCII format #PB_UTF8 : Writes the string in UTF8 format #PB_Unicode: Writes the string in UTF16 format If this parameter is not specified, the string will be written in UTF8 format if the program is compiled in unicode mode and in ASCII format otherwise.