ultrix man page for dwtlistpendingitems

DwtListPendingItems(3Dwt)												 DwtListPendingItems(3Dwt)

Name
       DwtListPendingItems - Returns a list of data ID/private ID pairs for a specified format name.

Syntax
       int DwtListPendingItems(display, window, format_name,
			       item_list, count)
	    Display *display;
	    Window window;
	    char *format_name;
	    DwtClipboardPendingList *item_list;
	    unsigned long *count;

Arguments
       display	 Specifies  a pointer to the Display structure that was returned in a previous call to XOpenDisplay.  For information on XOpenDis-
		 play and the Display structure, see the Guide to the Xlib Library: C Language Binding.

       window	 Specifies the window ID that relates the application window to the clipboard.	The same application instance should pass the same
		 window ID to each clipboard function 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 DwtClip-
		 boardPendingList.  The application is responsible for freeing the memory provided by this function for storing the list.

       item_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 zero.

Description
       The  DwtListPendingItems  function  returns a list of data ID/private ID pairs for a specified format name.  For the purposes of this func-
       tion, 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.

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

Return Values
       This function returns one of these status return constants:

       ClipboardSuccess   The  function is success-
			  ful.
       ClipboardLocked	  The	 function    failed
			  because the clipboard was
			  locked by another  appli-
			  cation.   The application
			  can continue to call	the
			  function  with  the  same
			  parameters   until	the
			  clipboard   is  unlocked.
			  Optionally, the  applica-
			  tion	can ask if the user
			  wants to keep  trying  or
			  to  give up on the opera-
			  tion.

See Also
       Guide to the XUI Toolkit: C Language Binding
       Guide to the XUI Toolkit Intrinsics: C Language Binding

															 DwtListPendingItems(3Dwt)