ssCore.FileSys.readFileUTF16

Read the contents of a unicode file in a single operation.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

path - A fully qualified file path. This parameter supports monikers.

requireBOM - [Optional] - Determines whether or not an error is generated if the BOM (byte order marker) is missing. Valid values include: true,false. Default value is true.


Output Parameters:

result - Contents of specified file.


Asynchronous Mode:

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

ssCore.FileSys.readFileUTF16( 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.readFileUTF16( paramsObject );


Notes:

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

                

Examples:

var return_obj = ssCore.FileSys.readFileUTF16({path:"startdir://file.txt"});

ssDebug.trace(return_obj.result);