Soap.SOAPAttachIntf.IMimeAttachmentHandler.CreateMimeStream

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure CreateMimeStream(Envelope: TStream; Attachments: TSoapDataList);

C++

virtual void __fastcall CreateMimeStream(System::Classes::TStream* Envelope, TSoapDataList* Attachments) = 0 ;

Properties

Type Visibility Source Unit Parent
procedure
function
public
Soap.SOAPAttachIntf.pas
Soap.SOAPAttachIntf.hpp
Soap.SOAPAttachIntf IMimeAttachmentHandler

Description

Creates and initializes a stream that will eventually contain an assembled multipart form.

Call CreateMimeStream as the first step when generating a multipart form to represent a SOAP packet and its associated attachments.

Envelope is a stream from which CreateMimeStream can read the SOAP envelope portion of the multipart form. This must be a complete encoding with the exception of headers, which can be added by subsequent calls to the AddSoapHeader method.

Attachments is a list of TSoapAttachment objects that represent the attachments that should be included in the multipart form.

CreateMimeStream creates a new stream object and initializes it with the data from Envelope and Attachments. This new stream can then be completed by calling the AddSoapHeader method to add any headers to the SOAP envelope portion and then calling the FinalizeStream method. After calling FinalizeStream, the application can access the generated stream by calling the GetMIMEStream method.

See Also