ultrix man page for dwtcopytoclipboard

DwtCopyToClipboard(3Dwt)												  DwtCopyToClipboard(3Dwt)

Name
       DwtCopyToClipboard - Copies a data item to the clipboard.

Syntax
       int DwtCopyToClipboard(display, window, item_id,
			       format_name, buffer, length,
			       private_id, data_id)
	    Display *display;
	    Window window;
	    long item_id;
	    char *format_name;
	    char *buffer;
	    unsigned long length;
	    int private_id;
	    int *data_id;

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.

       item_id	 Specifies the number assigned to this data item.  This number was returned by a previous call to DwtBeginCopyToClipboard.

       format_name
		 Specifies the name of the format in which the data item is stored.

       buffer	 Specifies the buffer from which the clipboard copies the data.

       length	 Specifies the length of the data being copied to the clipboard.

       private_id
		 Specifies the private data that the application wants to store with the data item.

       data_id	 Specifies  an	identifying number assigned to the data item that uniquely identifies the data item and the format.  This argument
		 is required only for data that is passed by name.

Description
       The DwtCopyToClipboard function copies a data item to clipboard storage.  The data item is not  actually  entered  in  the  clipboard  data
       structure  until the call to DwtEndCopyToClipboard.  Additional calls to DwtCopyToClipboard before a call to DwtEndCopyToClipboard add data
       item formats to the same data item or append data to an existing format.

       If the buffer argument is NULL, the data is considered passed by name.  If data passed by name is later needed by another application,  the
       application  that owns the data receives a callback with a request for the data.  The application that owns the data must then transfer the
       data to the clipboard with the DwtReCopyToClipboard function.  When a data item that was passed by name is deleted from the clipboard,  the
       application that owns the data receives a callback that states that the data is no longer needed.

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
       DwtEndCopyToClipboard(3Dwt)
       Guide to the XUI Toolkit: C Language Binding
       Guide to the XUI Toolkit Intrinsics: C Language Binding

															  DwtCopyToClipboard(3Dwt)