ssCore.FileSys.writeToFileUTF16

Writes data to a unicode text file in a single operation in UTF 16 format.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

path - A fully qualified path to the file you want to write. This parameter supports monikers.

writeBOM - [Optional] - Write the BOM (byte order marker) at the beginning of the file. Valid values include: true,false. Default value is true.

bigEndian - [Optional] - Write to the file in big-endian byte order. Valid values include: false,true. Default value is false.

data - Data to be written.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.FileSys.writeToFileUTF16( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.FileSys.writeToFileUTF16( paramsObject );


Notes:

You can't use this function to create binary files, just text files.

If the specified file does not exist it will be created. FileSys.writeToFileUTF16 will not create folders that are part of the path, so the target directory must exist (see FileSys.createDir).

All data in the specified file will be lost. You can use FileSys.appendToFileUTF16 to add data to a text file that already exists.

                

Examples:

ssCore.FileSys.writeToFileUTF16({path:"startdir://file.txt", data:"Hello"});