ReadOPML Method

Reads and parses an OPML file.

Syntax

rss.readOPML(OPMLFile, [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 reads in the OPML file specified by OPMLFile. The class then parses the file and returns the data to the user in the OPMLHeader and OPMLOutline events.