IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

MaxLines Property

The maximum number of message lines aside from headers to retrieve.

Syntax

 nntp.getMaxLines([callback])
 nntp.setMaxLines( maxLines, [callback])

Default Value

0


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 getMaxLines([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 setMaxLines([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 is used to limit the number of text lines aside from headers retrieved for messages. This property is used in conjunction with the ArticleText property. Please note that due to NNTP protocol limitations, the full text of the article is always retrieved from the server, but only MaxLines will be stored in ArticleText.

The default value of the property is 0. In this case the entire message will be retrieved, without interruptions.

This property is not available at design time.

Data Type

Long

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0