SetMessageStream Method

Sets the stream to which the message downloaded from the server will be written.

Syntax

• C++

ANSI (Cross Platform)
int SetMessageStream(IPWorksStream* sMessageStream);

Unicode (Windows)
INT SetMessageStream(IPWorksStream* sMessageStream);

#define MID_POP_SETMESSAGESTREAM 14

IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_POP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method sets the stream to which the message downloaded from the server will be written. If a download stream is set before the Retrieve method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0. The class will automatically close this stream if CloseStreamAfterTransfer is set to true (default). If the stream is closed, you will need to call SetMessageStream again before calling Retrieve again. The downloaded content will be written starting at the current position in the stream.

Note: SetMessageStream and LocalFile will reset the other.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)