名称

XmClipboardInquireFormat — 指定されたフォーマット名を返すクリップボード関数

形式

#include <Xm/Xm.h>
#include <Xm/CutPaste.h> int XmClipboardInquireFormat (display, window, index, format_name_buf, buffer_len, copied_len)
Display∗ display;
Windowwindow;
intindex;
char∗ format_name_buf;
unsigned long buffer_len;
unsigned long ∗ copied_len;

解説

XmClipboardInquireFormat は、クリップボードの中のデータ項目に指定されたフォーマット名を返します。 名前を短く切らなければならないときは警告のステータスを返します。

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

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

index順番のついたフォーマット名の何番目を得るかを指定します。 この番号 i がデータ項目のフォーマットの数より大きい場合は、引数 copied_len にゼロを返します。

format_name_buf
フォーマット名を受け取るバッファを指定します。

buffer_lenフォーマット名を受け取るバッファのバイト数を指定します。

copied_lenバッファにコピーされた文字列のバイト数を示します。 この引数がゼロならば、このデータ項目に n番目 のフォーマットはありません。

リターン値

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

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

ClipboardTruncate
データを入れるのに十分な大きさのバッファをユーザが用意しなかったため、返されたデータが途切れてしまいました。

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

関連事項

XmClipboardStartCopy(3XM)

NEWS-OSRelease 4.2.1R