ssCore.BinaryFile.close

Close the open file.


Availability:

First available in version 3.7 build 197.


Input Parameters:

None.


Output Parameters:

systemError - A system specific error code from the GetLastError function.


Asynchronous Mode:

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

ssCore.BinaryFile.close( 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.BinaryFile.close( paramsObject );


Notes:

You can use one instance of the BinaryFile plugin to work with multiple files but you can only work with one file at a time. Before you can start working with another file you have to close the one you're working with.

If you attempt to close a file that you have locked for exclusive access, the call to close will fail.

                

Examples:

sSCore.BinaryFile.open({path:"startdir://file1.dat", accessMode:"write"});
// work with file1
ssCore.BinaryFile.close({});

// As long as we close file1.dat when we're done using it we can
// reuse the same instance of the plugin to open other files.

sSCore.BinaryFile.open({path:"startdir://file2.dat", accessMode:"write"});
// work with file2
ssCore.BinaryFile.close({});