Open a message on the server.
Syntax
object.OpenMessage( [MessageNumber],
[Options] )
Parameters
- MessageNumber
- Number of message to retrieve. This value must be greater than
zero. The first message in the mailbox is message number one. If
this argument is omitted, the current message selected by the
Message property will be opened.
- 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 succeeds.
Otherwise, a non-zero error code is returned which indicates the
cause of the failure.
Remarks
The OpenMessage method opens a message for reading from the
server. The client can read the contents of the message using the
Read method, and once all of the data has been read, the
message should be closed by calling the CloseMessage
method.
See Also
Message Property,
CloseMessage Method,
GetMessage Method,
Read Method
|