ITnef::Finish
適用対象: Outlook 2013 | Outlook 2016
キューに入れ、待機しているすべての Transport-Neutral カプセル化形式 (TNEF) 操作の処理を完了します。
HRESULT Finish(
ULONG ulFlags,
WORD FAR * lpKey,
LPSTnefProblemArray FAR * lpProblem
);
パラメーター
ulFlags
[����]�\��Ă��܂��B0 �ɂ���K�v������܂��B
lpKey
[out]添付ファイルの PR_ATTACH_NUM (PidTagAttachNumber) キー プロパティへのポインター。 TNEF カプセル化オブジェクトは、このキーを使用して、添付ファイルをメッセージ内の添付ファイル配置タグと照合します。 このキーは、各添付ファイルに対して一意である必要があります。
lpProblem
[out]返された STnefProblemArray 構造体へのポインター。 STnefProblemArray 構造体は、適切にエンコードされていないプロパティ (存在する場合) を示します。 lpProblem パラメーターに NULL が渡された場合、プロパティの問題配列は返されません。
戻り値
S_OK
呼び出しは成功し、期待される値または値を返しました。
注釈
トランスポート プロバイダー、メッセージ ストア プロバイダー、ゲートウェイは、ITnef::Finish メソッドを呼び出して、ITnef::AddProps メソッドと ITnef::SetProps メソッドの呼び出しでエンコードが要求されたすべてのプロパティのエンコードを実行します。 OpenTnefStream 関数または OpenTnefStreamEx 関数のTNEF_ENCODE フラグを使用して TNEF オブジェクトが開かれた場合、Finish メソッドは要求されたプロパティを、そのオブジェクトに渡されたカプセル化ストリームにエンコードします。 TNEF オブジェクトが TNEF_DECODE フラグで開かれた場合、 Finish メソッドは TNEF ストリームからプロパティをデコードし、それらが属するメッセージに書き戻します。
Finish 呼び出しの後、カプセル化ストリームへのポインターは TNEF データの末尾を指します。 Finish 呼び出し後にプロバイダーまたはゲートウェイが TNEF ストリーム データを使用する必要がある場合は、ストリーム ポインターを TNEF ストリーム データの先頭にリセットする必要があります。
TNEF 実装は 、完了 プロセスを停止せずに TNEF ストリーム エンコードの問題を報告します。 lpProblem パラメーターで返される STnefProblemArray 構造体は、処理できなかった TNEF 属性または MAPI プロパティ (存在する場合) を示します。 STnefProblemArray に含まれる STnefProblem 構造体の scode メンバーで返される値は、特定の問題を示します。 プロバイダーまたはゲートウェイは、 Finish が問題レポートを返さないすべてのプロパティまたは属性が正常に処理されたという前提で動作できます。
プロバイダーまたはゲートウェイが問題のある配列で動作しない場合は、 lpProblem で NULL を渡すことができます。この場合、問題のある配列は返されません。
lpProblem で返される値は、呼び出しがS_OKを返す場合にのみ有効です。 S_OKが返されると、プロバイダーまたはゲートウェイは、STnefProblemArray 構造体で返される値をチェックする必要があります。 呼び出しでエラーが発生した場合、 STnefProblemArray 構造体は入力されず、呼び出し元プロバイダーまたはゲートウェイは構造体を使用または解放しないでください。 呼び出しでエラーが発生しない場合、呼び出し元のプロバイダーまたはゲートウェイは、MAPIFreeBuffer 関数を呼び出すことによって、STnefProblemArray のメモリを解放する必要があります。
MFCMAPI リファレンス
MFCMAPI のサンプル コードについては、次の表を参照してください。
| ファイル | 関数 | コメント |
|---|---|---|
| File.cpp |
SaveToTNEF |
MFCMAPI では 、ITnef::Finish メソッドを使用して、新しい TNEF ストリームの処理を完了します。 |