IMAPIViewContext::GetSaveStream

The IMAPIViewContext::GetSaveStream method retrieves a stream in which a version of the current message converted to text format will be placed.

Quick Info

See IMAPIViewContext : IUnknownTR60NE.

HRESULT GetSaveStream(

Parameters

pulFlags

[out] Pointer to a bitmask of flags that controls the type of the saved text. The following flag can be set:

MAPI_UNICODE

The returned text is in Unicode format. If the MAPI_UNICODE flag is not set, the text is in ANSI format.

pulFormat

[out] Pointer to a bitmask of flags that controls additional formatting characteristics. The following flags can be set:

SAVE_FORMAT_RICHTEXT

The message is converted to Rich Text Format.

SAVE_FORMAT_TEXT

The message is converted to plain text format.

ppstm

[out] Pointer to a pointer where the converted version of the message is written.

Return Value

S_OK

The call succeeded and has returned the expected value or values.

Remarks

Form objects call the IMAPIViewContext::GetSaveStream method to support the Save As verb set for form viewers. A stream interface is returned to the form. Forms are not permitted to write any data before the seek pointer on entry, and they must leave the seek pointer at the end of the converted message when done. The message should be fully converted to text and placed into the stream before returning from the IMAPIForm::DoVerbLH33OI call.

For information about implementing the interfaces related to form servers, see MAPI Form Interfaces Used by Client Applications1AR39HN.