GroupOverviewReferences Property

The references of an article in a newsgroup overview.

Syntax

 nntp.getGroupOverviewReferences(index, [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 getGroupOverviewReferences([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 setGroupOverviewReferences([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

The references of an article in a newsgroup overview.

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

This property is read-only and not available at design time.

Data Type

String