|
Summary
Provide message data for extraction.
Syntax
| Boolean ExtractMessageData (Buffer, Len, IsFile) |
| |
Buffer |
VARIANT FAR* |
| |
Len |
Long |
| |
IsFile |
Boolean |
Description
To extract a message the ExtractMessageStart method must be called, then the
ExtractMessageData must be called to pass the message to be extracted to the control. When
all the data has been passed to the control the ExtractMessageEnd method must be called to
signal the MIME ActiveX control to begin the extraction process. Once the
ExtractMessageEnd method has been called the extracted message and any attachments are
delivered to the application in one or more OnRecvAddrField, OnRecvHeader and OnRecvBody
(or OnRecvBodyB) events. This method separates the actual message from its attachments.
The application must pass the entire data that needs to be extracted to the control
through one or more calls to this method. This method should called only after a
successful call has been made to the ExtractMessageStart method.
The ExtractMessageData method takes a pointer to a VARIANT (Buffer) containing
data and the length of data (Bytes) pointed to by Buffer, and a Boolean IsFile flag
as parameters. The IsFile parameter should be set to 0 when Buffer
contains the data to be extracted. The application can also pass the name of the file
containing the data in Buffer, in this case the IsFile parameter should be
set to 1. In either case the Len parameter should be set to the size of the buffer.
One last call should be made with the Len parameter set to 0 and Buffer
to an empty string to indicate the end of data. Only after this last call the application
should call the ExtractMessageEnd method to finish the extracting process.
Note that only VT_ARRAY and VT_BSTR data types are supported for the Buffer
parameter, if the data type is anything else then the Mime ActiveX Control will return an
error.
If an error occurs, then the OnError event will be fired. The application may want to
display an error message in the OnError event to inform the user of the error. Please
check the reference page of the OnError event for a complete listing of error codes.
Return Value
This method will return TRUE if successful, or else it will return False if it fails.
The application should check the return value to determine if the method was successful.
Example
Result = Mime.ExtractMessageData ("c:\temp\test.msg",
bufferLen, 1)
If Result = True Then
MsgBox "Data successfully received", 64, "Sample Program"
End If
| 
