Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.1   6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4    Statistic  

BinaryFile.WriteText

Writes a text file with the given text.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
BinaryFile 7.3 Yes Yes Yes Yes Yes

MBS( "BinaryFile.WriteText"; BinaryFileRef; Text { ; Encoding } )

Parameters

Parameter Description Example value
BinaryFileRef The reference number for the open file. $FH
Text The text to write. "Hello World"
Encoding Optional
The text encoding for text parameter.
Default is UTF-8.
Possible encoding names: ANSI, Arabic-Mac, Arabic-Win, Baltic-Win, CentralEurope-Mac, ChineseSimp-Mac, ChineseSimp-Win, ChineseTrad-Mac, ChineseTrad-Win, Cyrillic-Mac, Cyrillic-Win, EasternEurope-Win, Greek-Mac, Greek-Win, Hebrew-Mac, Hebrew-Win, ISO-8859-1, ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, ISO-8859-15, Korean-Johab, Korean-Mac, Korean-Win, Latin1, Mac, Native, ShiftJIS-Mac, ShiftJIS-Win, Turkish-Mac, Turkish-Win, UTF-8, DOS or Windows. Pass native to use the native encoding of the current platform.
"UTF-8"

Result

Returns OK or error.

Description

Writes a text file with the given text.
You have to decide which encoding to use (if not UTF-8). We support a few encodings, but we can add more if you need something special.
Please use Text.ReplaceNewline to define which line endings the file has.
If text encoding doesn't support given characters, they are converted to close match if possible or replaced by question marks.

You can pass UTF-16, UTF-16LE or UTF-16BE for encoding, too.

See also Text.WriteTextFile and Text.WriteToContainer.

Examples

Write Hello:

MBS( "BinaryFile.WriteText"; $fh; "Hello"; "UTF8")

See also


BinaryFile.WriteInt   -   CGImageSource.Count

Feedback: Report problem or ask question.




Links
MBS Xojo Plugins