名称

XmClipboardLock — クリップボードをロックするクリップボード関数

形式

#include <Xm/Xm.h>
#include <Xm/CutPaste.h> int XmClipboardLock (display, window)
Display∗ display;
Windowwindow;

解説

XmClipboardLock は、XmClipboardUnlock が呼び出されるまで他のアプリケーションのアクセスからクリップボードをロックします。 すべてのクリップボード関数は、同時アクセスを防ぐためにロック、アンロックを行っています。 この関数によって、アプリケーションに対して Inquire 関数と他のクリップボード関数の呼び出しの間にクリップボードのデータが変わらないようにしておくことができます。 アプリケーションは、XmClipboardStartCopy と XmClipboardEndCopy の呼び出しの間、または XmClipboardStartRetrieve と XmClipboardEndRetrieve の呼び出しの間は、ロックする必要はありません。

アプリケーションは、XmClipboardCopyByName を複数回呼び出すときには、その前にクリップボードをロックし、完了したら解除しなければなりません。

クリップボードがすでに他のアプリケーションによってロックされている場合、 XmClipboardLock はエラーのステータスを返します。 同一のアプリケーションによるこの関数の複数回呼び出しは、ロックのレベルを増加します。

displayXOpenDisplay または XtDisplay の呼び出しで返された Display 構造体へのポインタを指定します。

windowアプリケーションウィンドウをクリップボードに関係づけるための widget のウィンドウ ID を指定します。 widget のウィンドウ ID は XtWindow を用いることにより得られます。 同じアプリケーションインスタンスは、呼び出す各クリップボード関数に対して同じウィンドウ ID を渡さなければなりません。

リターン値

ClipboardSuccess
関数の実行に成功しました。

ClipboardLocked
クリップボードが他のアプリケーションにロックされているため、関数の実行に失敗しました。 アプリケーションはロックが解除されるまで同じ引数で何度も関数を呼び続けることができます。 このことを利用して、アプリケーションはユーザに操作を試み続けるかあきらめるかたずねることができます。

関連事項

XmClipboardCopyByName(3XM), XmClipboardEndCopy(3XM), XmClipboardEndRetrieve(3XM), XmClipboardStartCopy(3XM), XmClipboardStartRetrieve(3XM), XmClipboardUnlock(3XM)

NEWS-OSRelease 4.1C