ReadFile Method

Load an Atom file into the component.

Syntax

atom.readFile(fileName, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method loads an Atom file and attempts to parse it, filling in the Channel and Entries properties as it goes. The Channel properties can also be accessed using the GetProperty and SetProperty methods if necessary.