:ListNewGroups()
Class
Syntax
:ListNewGroups( [dDate], [cTime], [nReturnType], [hSession] ) -> acGroupList
Parameters
|
|
dDate |
Date. Date indicating the beginning date to use for query. Default is Date() |
|
|
cTime |
String indicating the beginning time to use for query. Default is Time() |
|
|
nReturnType |
Optional: Specifies the return type. Default is String. RETURN_STRING = Return results in String format. RETURN_ARRAY = Return results in an Array. |
|
|
hSession |
Optional: If hSession is not passed, the value in :Session will be used |
Return
List of avalable newsgroups .
Description
The :ListNewGroups() method returns a list of newsgroups that were created since the specified date.
If nReturnType is not passed or is RETURN_STRING then each newsgroup is returned to the client as a line of text, terminated by a carriage return/linefeed character sequence.
The format of the data returned by the server is as follows:
{newsgroup}[space]{last-article}[space]{first-article}[space]{moderated-flag}[cr][lf]
If nReturnType is RETURN_ARRAY, then each element is a line of text with the structure shown above.
The first and last article numbers specify the articles which are available for the newsgroup on the server.
The moderated flag specifies if the newsgroup is maintained by a moderator. If the flag is 'm' then group is moderated. If it is 'y', the group is unmoderated.
Note: Published standards indicate 'y' for unmoderated and 'n' for moderated, but actual implementations have followed the above description. In newsgroup parlance, a group to which posting is permitted is termed "unmoderated".
The list of newsgroups and article numbers are unique to each server. It is possible that there will be gaps in the articles within the range of the first and last articles in the newsgroup. This may be due to a message being canceled or expired.
See Also
:GetArticleByNumber(), :GetArticleByMessageId(), :GetArticleRange(), :GetNextArticle(), :GetPreviouseArticle(), :ListGroups(), :GetArticleRange(), :GetCurrentArticle(), :SelectGroup()