


XmClipboardEndCopy(3X)				       XmClipboardEndCopy(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmCClliippbbooaarrddEEnnddCCooppyy - A clipboard function that ends a	copy to	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dCCooppyy ((_d_i_s_p_l_a_y, _w_i_n_d_o_w, _i_t_e_m__i_d))
       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;;
       lloonngg	 _i_t_e_m__i_d;;

DESCRIPTION
  XXmmCClliippbbooaarrddEEnnddCCooppyy locks the clipboard from access by	other applications,
  places data in the clipboard data structure, and unlocks the clipboard.
  Data items copied to the clipboard by	XXmmCClliippbbooaarrddCCooppyy	are not	actually
  entered in the clipboard data	structure until	the call to XXmmCClliippbbooaarr--
  ddEEnnddCCooppyy.

  This function	also frees up temporary	storage	that was allocated by XXmmCClliipp--
  bbooaarrddSSttaarrttCCooppyy, which	must be	called before XXmmCClliippbbooaarrddEEnnddCCooppyy.  The latter
  function should not be called	if XXmmCClliippbbooaarrddCCaanncceellCCooppyy has been called.

  _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 clipboard function	it
	      calls.

  _i_t_e_m__i_d     Specifies	the number assigned to this data item.	This number
	      was returned by a	previous call to XXmmCClliippbbooaarrddSSttaarrttCCooppyy.

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.

  CClliippbbooaarrddFFaaiill
	      The function failed because XXmmCClliippbbooaarrddSSttaarrttCCooppyy was not
	      called.

RELATED	INFORMATION
  XXmmCClliippbbooaarrddCCaanncceellCCooppyy((33XX)), XXmmCClliippbbooaarrddCCooppyy((33XX)) and
  XXmmCClliippbbooaarrddSSttaarrttCCooppyy((33XX)).



