4.2.4.4 Cancelメソッド

Linkexpress 利用者プログラム開発ガイド

目次索引

Cancelメソッドは、現在、実行中の要求に対する中断を要求します。中断させる処理要求の種別により、以下の処理を行います。

なお、メッセージ送信およびジョブ起動要求(ジョブ起動完了時指定)中に本メソッドを呼び出しても、キャンセルできません(無視されます)。

要求の受付結果は、CategoryCode(エラー分類コード)、DetailCode(詳細エラーコード)、DiagType(エラー診断タイプ)およびErrorCode(エラー原因コード)プロパティで通知されます。

TRUE : 正常完了。

FALSE : 異常完了。プロパティにエラー詳細が設定されます。

Cancelメソッドのプロパティはすべてメソッドの復帰情報として返されるプロパティです。呼び出しの際に値の設定が必要なプロパティはありません。
Cancelメソッドは、Sendメソッド、ReceiveメソッドまたはExecuteJobメソッドが呼び出されていて、それに対するCompleteイベントを受け付けるまでの間でだけ呼び出すことができます。それ以外のタイミングでは、Cancelメソッドの呼び出しは拒否されます。
当機能は完了復帰型(注)です。復帰情報としてCancelメソッドの実行結果がプロパティに設定されます。なお、キャンセルしたファイル転送要求の完了およびジョブ起動(ジョブ結果待ち指定時)要求は、Completeイベントで通知されます。
プロパティ設定時にコントロールでパラメタエラーを検出した時は、スロー(例外)通知を行います。メソッド呼び出し時のパラメタ異常を検出した時は、メソッドから異常復帰します。どちらの場合にも、プロパティにエラー詳細が設定されます。

注) 完了復帰型：
ファイル転送が完了してからメソッド(サービス)が復帰します。メソッドの実行結果が転送処理の結果を示します。

目次索引