


XmClipboardCancelCopy(3X)			    XmClipboardCancelCopy(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmCClliippbbooaarrddCCaanncceellCCooppyy	- A clipboard function that cancels 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dCCaanncceellC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dCCaanncceellCCooppyy	cancels	the copy to clipboard that is in progress and
  frees	up temporary storage.  When a copy is to be performed, XXmmCClliipp--
  bbooaarrddSSttaarrttCCooppyy allocates temporary storage for the clipboard data.  XXmmCClliipp--
  bbooaarrddCCooppyy copies the appropriate data	into the the temporary storage.
  XXmmCClliippbbooaarrddEEnnddCCooppyy copies the	data to	the clipboard structure	and frees up
  the temporary	storage	structures.  If	XXmmCClliippbbooaarrddCCaanncceellCCooppyy is called, the
  XXmmCClliippbbooaarrddEEnnddCCooppyy function does not have to be called.  A call to XXmmCClliipp--
  bbooaarrddCCaanncceellCCooppyy is valid only	after a	call to	XXmmCClliippbbooaarrddSSttaarrttCCooppyy and
  before a call	to 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_ySpecifies 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 functions that it calls.

  _i_t_e_m__i_dSpecifies 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
	      or because the data item contains	too many formats.

RELATED	INFORMATION
  XXmmCClliippbbooaarrddCCooppyy((33XX)), XXmmCClliippbbooaarrddEEnnd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)).




