GetHeaders Method

Retrieves the headers for the specified message from the server.

Syntax

object.GetHeaders( MessageNumber, Headers )

Remarks

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

MessageNumber
Number of the message to retrieve from the server. This value must be greater than zero. The last available message number is returned by the LastMessage property.
Headers
A string or byte array which will contain the data transferred from the remote server when the method returns.

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

GetMessage Method, OpenMessage Method, OnProgress Event


Copyright © 2008 Catalyst Development Corporation. All rights reserved.