|
|
Whitebeam Object Definition
|
Method Description
Member.get()
Search the membership records.
Syntax
Member.MemberIterator = Member.get(keywords, flags)
Parameters
The 'Member.get' method takes 2 parameters:
| Name | Type/Value | Range/Length | Description | | keywords | array of strings | array of 0-10 keyword strings, of < 128 characters each | Required. A list of up to 10 keywords to be searched for. Keywords are additive (that is to say that searches will match any entry which contains any of the keywords | | flags | struct Member.searchFlags | see definition | Optional. Flags, see definition of searchflags |
Results
This method returns an instance of MemberIt - the member iterator. The member iterator inherits from Member and
adds the standard iterator methods (See the iterator tutorial for details). The formal definition
of the iterator methods can be found here.
Remarks
Search the membership records for members that have one of a set of keywords defined. The search behaviour is modified by the value of the
searchFlags parameter.
 | This is a static - or class method. It is always invoked on 'Member' rather than on an instance of that class.
|
Example
// Search for all members with 'car' or 'motorcycle'
// in their keyword list.
var iterator = Memeber.get(["car","motorcycle"],{searchKeywords:true});
while (iterator.getNextRow()) {
// iterator can now be treated as an instance of Member -
// that is it contains all the properties for this specific next
// Member retrieved from the membership store.
}
|
|
|
(loadtime : 9ms) |
