運用コマンドレファレンス Vol.1


eventmonitor.event_delete

イベント監視を停止します。

[関数名]

event_delete(event_id= eventmonitor.EVENT_ALL_DEL)

[引数]

event_id

削除対象の監視イベントIDを指定します。

この引数のデフォルト値はeventmonitor.EVENT_ALL_DELです。eventmonitor.EVENT_ALL_DELを指定した場合,呼び出し元で登録した監視イベントをすべて停止します。

[戻り値]

整数型

0を返します。

[例外]

表20‒11 eventmonitor.event_deleteの例外クラス一覧

例外クラス名

説明

TypeError

引数の型に誤りがあります。

ValueError

引数に不正な値が指定されています。

SystemError

システムエラーが発生しました。

KeyboardInterrupt

[Ctrl+C]の入力によってコマンドが中断されました。

eventmonitor.DeleteError

イベント削除に失敗しました。

[詳細]

引数で指定した監視イベントIDのイベント監視を停止します。

引数で指定する監視イベントIDがほかのスクリプトから登録されたIDの場合,eventmonitor.DeleteErrorを返します。

正常終了の場合,戻り値に0が格納されます。異常終了の場合,例外を発生させます。

[注意事項]

  1. 自分以外のプロセスから登録された監視イベントIDのイベント監視は停止できません。

  2. 存在しない監視イベントIDを指定した場合は,0を返します。

[備考]