Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xmclipboardinquirependingitems(3) [redhat man page]

XmClipboardInquirePendingItems(library call)							      XmClipboardInquirePendingItems(library call)

NAME

       XmClipboardInquirePendingItems -- A clipboard function that returns a list of data ID/private ID pairs

SYNOPSIS

       #include <Xm/CutPaste.h>
       int XmClipboardInquirePendingItems (display, window, format_name, item_list, count)
	       Display * display;
	       Window  window;
	       char    * format_name;
	       XmClipboardPendingList  * item_list;
	       unsigned long   * count;
       (void)

DESCRIPTION

       XmClipboardInquirePendingItems  returns a list of data ID/private ID pairs for the specified format name. A data item is considered pending
       if the application originally passed it by name, the application has not yet copied the data, and the item has not been	deleted  from  the
       clipboard.   The  application  is responsible for freeing the memory provided by this function to store the list.  To free the memory, call
       XtFree.

       This function is used by an application when exiting, to determine if the data that is passed by name should be sent to the clipboard.

       display	 Specifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay or XtDisplay.

       window	 Specifies the window ID of a widget that relates the application window to the clipboard. The widget's window ID can be  obtained
		 through XtWindow.  The same application instance should pass the same window ID to each of the clipboard functions that it calls.

       format_name
		 Specifies a string that contains the name of the format for which the list of data ID/private ID pairs is to be obtained.

       item_list Specifies  the  address  of  the array of data ID/private ID pairs for the specified format name. This argument is a type XmClip-
		 boardPendingList.  The application is responsible for freeing the memory provided by this function for storing the list.

       count	 Specifies the number of items returned in the list. If there is no data for the specified format name, or if there is no item	on
		 the clipboard, this argument equals 0 (zero).

RETURN

       XmClipboardSuccess
		 The function was successful.

       XmClipboardLocked
		 The  function	failed	because the clipboard was locked by another application. The application can continue to call the function
		 again with the same parameters until the lock goes away. This gives the application the opportunity to ask if the user  wants	to
		 keep trying or to give up on the operation.

RELATED

       XmClipboardStartCopy(3).

												      XmClipboardInquirePendingItems(library call)

Check Out this Related Man Page

XmClipboardInquireLength(3X)											      XmClipboardInquireLength(3X)

NAME

       XmClipboardInquireLength - A clipboard function that returns the length of the stored data

SYNOPSIS

       #include <Xm/Xm.h> #include <Xm/CutPaste.h>

       int XmClipboardInquireLength (display, window, format_name, length)
	       Display * display;
	       Window window;
	       char * format_name;
	       unsigned long * length;

DESCRIPTION

       XmClipboardInquireLength  returns  the  length of the data stored under a specified format name for the clipboard data item.  If no data is
       found for the specified format, or if there is no item on the clipboard, this function returns a value of zero.

       Any format passed by name is assumed to have the length passed in a call to XmClipboardCopy, even though the data has not yet  been  trans-
       ferred  to the clipboard in that format.  Specifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay
       or XtDisplay.  Specifies a widget's window ID that relates the application window to the clipboard.  The widget's window ID can be obtained
       by  using  XtWindow. The same application instance should pass the same window ID to each of the clipboard functions that it calls.  Speci-
       fies the name of the format for the data item.  Specifies the length of the next data item in the specified format.  This  argument  equals
       zero if no data is found for the specified format, or if there is no item on the clipboard.

RETURN VALUE

       The  function is successful.  The function failed because the clipboard was locked by another application.  The application can continue to
       call the function again with the same parameters until the lock goes away.  This gives the application the opportunity to ask if  the  user
       wants  to  keep	trying	or  to	give  up  on the operation.  The function could not find data on the clipboard corresponding to the format
       requested. This could occur because the clipboard is empty; there is data on the clipboard but not in the requested format; or the data	in
       the requested format was passed by name and is no longer available.

SEE ALSO

       XmClipboardCopy(3X), XmClipboardStartCopy(3X)

														      XmClipboardInquireLength(3X)
Man Page