EntrySummary Property

This property contains a short textual description of the Atom entry.

Syntax

 atom.getEntrySummary(index, [callback])
 atom.setEntrySummary(index,  entrySummary, [callback])

Default Value

""

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 the getEntrySummary([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setEntrySummary([callback]) 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 property contains a short textual description of the Atom entry.

The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String