IPWorks S/MIME 2020 C++ Edition

Questions / Feedback?

EncodeToString Method

Encodes to string.

Syntax

ANSI (Cross Platform)
int EncodeToString();

Unicode (Windows)
INT EncodeToString();
- (void)encodeToString;
#define MID_MIME_ENCODETOSTRING 8

IPWORKSSMIME_EXTERNAL int IPWORKSSMIME_CALL IPWorksSMIME_MIME_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method encodes to string. Same as EncodeToFile but the encoded data is held in the Message property rather than saved to a file.

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

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

The encoded message will be stored in the Message property; the message headers will be held by MessageHeaders.

Example (Encoding Data)


MIMEControl.ResetData()
MIMEControl.PartCount = 2
MIMEControl.PartDecodedString(0) = "This is plain text data"
MIMEControl.PartEncoding(0) = peQuotedPrintable
MIMEControl.PartContentType(0) = "text/plain"
MIMEControl.PartDecodedFile(1) = "C:\filename.txt"
MIMEControl.EncodeToString()

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

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks S/MIME 2020 C++ Edition - Version 20.0 [Build 8154]