GetHeaders Method  
 

Retrieves the headers for the specified article from the server.

Syntax

object.GetHeaders( Article, Headers )

Parameters

Article
Number of article to retrieve from the server, or a string that specifies the message ID of the article header to retrieve. If an article number is specified, 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.
Headers
A string or byte array which will contain the data transferred from the server when the method returns. This parameter must be passed by reference.

Return Value

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

Remarks

The GetHeaders method is used to retrieve an article header block 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.

See Also

CreateArticle Method, GetArticle Method, OpenArticle Method, OnProgress Event