


XmClipboardEndRetrieve(3X)			   XmClipboardEndRetrieve(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmCClliippbbooaarrddEEnnddRReettrriieevvee - A clipboard function	that ends a copy from the
  clipboard

SYNOPSIS


  ##iinncclluuddee <<XXmm//XXmm..hh>>
  ##iinncclluuddee <<XXmm//CCuuttPPaassttee..hh>>
  iinntt XXmmCClliippbbooaarrddEEnnddRReettrriieevvee ((_d_i_s_p_l_a_y, _w_i_n_d_o_w))
       DDiissppllaayy	 * _d_i_s_p_l_a_y;;
       WWiinnddooww	 _w_i_n_d_o_w;;

DESCRIPTION
  XXmmCClliippbbooaarrddEEnnddRReettrriieevvee suspends copying data incrementally from the clip-
  board.  It tells the clipboard routines that the application is through
  copying an item from the clipboard.  Until this function is called, data
  items	can be retrieved incrementally from the	clipboard by calling XXmmCClliipp--
  bbooaarrddRReettrriieevvee.

  _d_i_s_p_l_a_y     Specifies	a pointer to the DDiissppllaayy structure that	was returned
	      in a previous call to XXOOppeennDDiissppllaayy or XXttDDiissppllaayy.

  _w_i_n_d_o_w      Specifies	a widget's window ID that relates the application
	      window to	the clipboard.	The widget's window ID can be
	      obtained by using	XXttWWiinnddooww.  The same application	instance
	      should pass the same window ID to	each of	the clipboard func-
	      tions that it calls.

RETURN VALUE

  CClliippbbooaarrddSSuucccceessss
	      The function is successful.

  CClliippbbooaarrddLLoocckkeedd
	      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	INFORMATION
  XXmmCClliippbbooaarrddRReettrriieevvee((33XX)), XXmmCClliippbbooaarrddSSttaarrttCCooppyy((33XX)), and
  XXmmCClliippbbooaarrddSSttaarrttRReettrriieevvee((33XX)).














