名称

XmClipboardInquireLength — 格納されたデータの長さを返すクリップボード関数

形式

#include <Xm/Xm.h>
#include <Xm/CutPaste.h> int XmClipboardInquireLength (display, window, format_name, length)
Display∗ display;
Windowwindow;
char∗ format_name;
unsigned long ∗ length;

解説

XmClipboardInquireLength は、クリップボードのデータ項目に指定されたフォーマット名で格納されているデータの長さを返します。 指定されたフォーマットのデータがなかった場合、もしくはクリップボードに項目がない場合は、ゼロを値として返します。

名前で渡されたフォーマットはどれも、 まだそのフォーマットでデータがクリップボードに転送されていなくても、 XmClipboardCopy の呼び出しで渡された長さ length を持っているものとみなします。

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

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

format_nameデータ項目のフォーマットの名前を指定します。

length指定されたフォーマットの中の次のデータ項目の長さを示します。 指定されたフォーマットのデータがなかった場合や、クリップボードに項目がなかった場合はゼロです。

リターン値

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

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

ClipboardNoData
要求されたフォーマットに対応するデータが、クリップボードに見つかりませんでした。 このことは、クリップボードが空であるか、クリップボードにデータはあるが要求されたフォーマットでは存在しなかったか、要求されたフォーマットのデータが名前で渡されたものですでに利用できないような場合に起きます。

関連事項

XmClipboardCopy(3XM), XmClipboardStartCopy(3XM)

NEWS-OSRelease 4.2.1R