IMAPIViewContext::GetSaveStream
This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
Retrieves a stream to be used for saving the current message.
HRESULT GetSaveStream(
ULONG FAR * pulFlags,
ULONG FAR * pulFormat,
LPSTREAM FAR * ppstm
);
Parameters
pulFlags
[out] Pointer to a bitmask of flags that controls how the message text should be saved. The following flag can be set:- MAPI_UNICODE
The message text is saved in Unicode format. If the MAPI_UNICODE flag is not set, the text is saved in ANSI format.
- MAPI_UNICODE
pulFormat
[out] Pointer to a bitmask of flags that controls the format of the saved text. The following flags can be set:SAVE_FORMAT_RICHTEXT
The message text is to be saved as formatted text in the Rich Text Format (RTF).SAVE_FORMAT_TEXT
The message text is to be saved as plain text.
ppstm
[out] Pointer to a pointer to the stream that will contain the saved message.
Return Value
- S_OK
The stream was successfully retrieved.
Remarks
Form objects call the IMAPIViewContext::GetSaveStream method to retrieve a stream an object that implements the IStream interface to support the handling of the Save As verb in the form viewer. The IMAPIForm::DoVerb method, which is implemented in the form server and called by the form viewer to invoke a verb, should not return until the message is fully converted into the appropriate text format and placed into the appropriate stream.
Notes to Callers
Do not write to the stream pointed to by ppstm before calling GetSaveStream. When GetSaveStream returns, do not reset the position of the seek pointer. This pointer must remain at the end of the saved message text.