IMAPIViewContext::GetSaveStreamIMAPIViewContext::GetSaveStream

適用されます: OutlookApplies to: Outlook

現在のメッセージを保存するために使用するストリームを取得します。Retrieves a stream to be used for saving the current message.

HRESULT GetSaveStream(
ULONG FAR * pulFlags,
ULONG FAR * pulFormat,
LPSTREAM FAR * ppstm
);

ParametersParameters

pulFlagspulFlags

[out]メッセージ テキストを保存する方法を制御するフラグのビットマスクへのポインター。[out] Pointer to a bitmask of flags that controls how the message text should be saved. 次のフラグを設定することができます。The following flag can be set:

MAPI_UNICODEMAPI_UNICODE

メッセージ文字列は、Unicode 形式で保存されます。The message text is saved in Unicode format. MAPI_UNICODE フラグが設定されていない場合は、ANSI 形式のテキストが保存されます。If the MAPI_UNICODE flag is not set, the text is saved in ANSI format.

pulFormatpulFormat

[out]保存したテキストの書式を制御するフラグのビットマスクへのポインター。[out] Pointer to a bitmask of flags that controls the format of the saved text. 次のフラグを設定することができます。The following flags can be set:

SAVE_FORMAT_RICHTEXTSAVE_FORMAT_RICHTEXT

メッセージのテキストは、書式設定されたテキストで、リッチ テキスト形式式 (RTF) として保存するのには。The message text is to be saved as formatted text in the Rich Text Format (RTF).

SAVE_FORMAT_TEXTSAVE_FORMAT_TEXT

メッセージのテキストは、プレーン テキストとして保存するのには。The message text is to be saved as plain text.

ppstmppstm

[out]保存されたメッセージを格納するストリームへのポインターへのポインター。[out] Pointer to a pointer to the stream that will contain the saved message.

�߂�lReturn value

S_OKS_OK

ストリームが正常に取得しました。The stream was successfully retrieved.

備考Remarks

フォーム オブジェクトは、ストリーム形式のビューアーで、名前を付けて動詞の処理をサポートするためにIStreamインターフェイスを実装するオブジェクトを取得するIMAPIViewContext::GetSaveStreamメソッドを呼び出します。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. メッセージが完全に適切な文字列形式に変換し、適切なストリームに配置されるまで、 IMAPIForm::DoVerbメソッドは、フォームのサーバーに実装されているし、動詞を呼び出すフォーム ビューアーによって呼び出されます、する必要があります返されません。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

GetSaveStreamを呼び出す前に_ppstm_で指定されたストリームに書き込みます。Do not write to the stream pointed to by ppstm before calling GetSaveStream. 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.

関連項目See also

IMAPIViewContext: IUnknownIMAPIViewContext : IUnknown