ssCore.FileSys.readFileBinary

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


Availability:

First available in version 3.5 build 314.


Input Parameters:

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


Output Parameters:

result - Contents of specified file in hex string format.


Asynchronous Mode:

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

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


Notes:

None.


Examples:

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

// the file contents will be returned as a hex string
ssDebug.trace(return_obj.result);