EncodeToStream Method

Encodes to stream.

Syntax

• C++

ANSI (Cross Platform)
int EncodeToStream(IPWorksStream* sOutputStream);

Unicode (Windows)
INT EncodeToStream(IPWorksStream* sOutputStream);

#define MID_MIME_ENCODETOSTREAM 7

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

Remarks

This method encodes to stream. Same as EncodeToString but the encoded data is written to a stream instead of to the Message property.

This method encodes the data given in Parts collection into a MIME message. The Message gets written to the specified OutputStream and MessageHeaders using the values optionally given in Parts collection. To encode several objects into a MIME envelope, the user should first clear any old values left in the Parts collection by calling ResetData.

The class will check each item in Parts collection (first decoded file and then decoded string) for the data to encode.

The encoded message will be written to the specified OutputStream, and the message headers will be held by MessageHeaders.

Example (Encoding Data)

MIMEControl.ResetData()
MIMEControl.Parts.Add(new MIMEPart())
MIMEControl.Parts.Add(new MIMEPart())

MIMEControl.Parts[0].DecodedString = "This is plain text data"
MIMEControl.Parts[0].Encoding = peQuotedPrintable
MIMEControl.Parts[0].ContentType = "text/plain"
MIMEControl.Parts[1].DecodedFile = "C:\filename.txt"

MIMEControl.EncodeToStream(OutputStream)

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.)