XIfEvent(3X11)

名前
XIfEvent, XCheckIfEvent, XPeekIfEvent - 述語手続きを使ってイベントキューを確認する

書式
XIfEvent(display, event_return, predicate, arg)
      Display *display;
      XEvent *event_return;
      Bool (*predicate)();
      XPointer arg;

Bool XCheckIfEvent(display, event_return, predicate, arg)
      Display *display;
      XEvent *event_return;
      Bool (*predicate)();
      XPointer arg;

XPeekIfEvent(display, event_return, predicate, arg)
      Display *display;
      XEvent *event_return;
      Bool (*predicate)();
      XPointer arg;

引き数

arg 述語手続きに渡すユーザ指定の引き数を指定する。

display
    X サーバへの接続を指定する。

event_return
    マッチしたイベント関連構造体かそのコピーが返される。

predicate
    キューの中の次のイベントが必要なものか決定するために呼ばれる手続きを 指定する。

説明
関数 は、指定した述語手続きがイベントに対して を返したときに限り完了する。 これはキューに入っているイベントにマッチしたことを示す。 は、追加のイベントを待ってブロックしていた場合、出力バッファをフラッシュ する。 はマッチするイベントをイベントキューから削除し、これをクライアントが与 えた 構造体にコピーする。

述語手続きがマッチした場合、 はマッチしたイベントをクライアントが与えた にコピーし、 を返す。 (このイベントはキューから削除される。) 述語手続きがマッチしなかった場合は、 は を返す。 キューに入っているこれ以前のイベントは全く破棄されない。

関数 は、指定した述語手続きがイベントに対して を返したときに限り、 を返す。 述語手続きがマッチした後で、 はマッチしたイベントをクライアントが与えた にコピーするが、そのイベントをキューからは削除しない。 は追加のイベントを待ってブロックしていた場合には、出力バッファの内容を 全て出力する。

関連項目
XAnyEvent(3X11), XNextEvent(3X11), XPutBackEvent(3X11) XSendEvent(3X11)
Xlib - C Language X Interface