GetArticle Method

Retrieve an article from the server.

Syntax

object.GetArticle( Article, Message, [Options] )

Remarks

The GetArticle method is used to retrieve an article from the server and copy it into a local buffer. This method will cause the current thread to block until the article transfer completes, a timeout occurs or the transfer is canceled. During the transfer, the OnProgress event will fire periodically, enabling the application to update any user interface objects such as a progress bar.

Article
Number of the article to retrieve from the server. This value must be greater than zero. The first available article in the newsgroup can be determined by checking the value of the FirstArticle property. The last available article in the newsgroup is returned by the LastArticle property.
Message
A string or byte array which will contain the data transferred from the remote server when the method returns.
Options
An optional integer value which specifies one or more options. This argument is reserved for future use and should be omitted.

Return Value

A value of zero is returned if the method was successful. Otherwise, a non-zero error code is returned which indicates the cause of the failure.

See Also

FirstArticle Property, LastArticle Property, CreateArticle Method, GetHeaders Method, OpenArticle Method, StoreArticle Method, OnProgress Event


Copyright © 2008 Catalyst Development Corporation. All rights reserved.