ssCore.Scratch.read

Read the contents of the scratch area in your application.


Availability:

First available in version 3.3 build 120.


Input Parameters:

secure - [Optional] - A boolean value that indicates whether to use secure reads or not. Valid values include: true and false. Default value is true.

binary - [Optional] - A boolean value that indicates whether the data being read is in binary (hex string) foramt or not. Valid values include: true and false. Default value is false.


Output Parameters:

result - The contents of the scratch area.


Asynchronous Mode:

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

ssCore.Scratch.read( 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.Scratch.read( paramsObject );


Notes:

None.


Examples:

var r = ssCore.Scratch.read({});
ssDebug.trace(r.result);