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

SearchPattern Property

A search pattern for the GroupSearch method.

Syntax

 nntp.getSearchPattern([callback])
 nntp.setSearchPattern( searchPattern, [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 getSearchPattern([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 setSearchPattern([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 search pattern for the GroupSearch method. The format of the pattern is the same as the patterns used by the UNIX 'find' command.

As an example, "* new *" will match all headers that contain the word "new".

This property is not available at design time.

Data Type

String

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