


XmClipboardCopyByName(3X)			    XmClipboardCopyByName(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmCClliippbbooaarrddCCooppyyBByyNNaammee	- A clipboard function that copies a data item passed
  by name

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CooppyyBByyNNaammee ((_d_i_s_p_l_a_y, _w_i_n_d_o_w, _d_a_t_a__i_d,
	    _b_u_f_f_e_r, _l_e_n_g_t_h, _p_r_i_v_a_t_e__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	 _d_a_t_a__i_d;;
       XXttPPooiinntteerr _b_u_f_f_e_r;;
       uunnssiiggnneedd	lloonngg_l_e_n_g_t_h;;
       lloonngg	 _p_r_i_v_a_t_e__i_d;;

DESCRIPTION
  XXmmCClliippbbooaarrddCCooppyyBByyNNaammee	copies the actual data for a data item that was	pre-
  viously passed by name to the	clipboard.  Data is considered to be passed
  by name when a call to XXmmCClliippbbooaarrddCCooppyy is made with a	NULL buffer parame-
  ter.	Additional calls to this function append new data to the existing
  data.

  _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	win-
	    dow	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.

  _d_a_t_a__i_d   Specifies an identifying number assigned to	the data item that
	    uniquely identifies	the data item and the format.  This number
	    was	assigned by XXmmCClliippbbooaarrddCCooppyy to the data	item.

  _b_u_f_f_e_r    Specifies the buffer from which the	clipboard copies the data.

  _l_e_n_g_t_h    Specifies the number of bytes in the data item.

  _p_r_i_v_a_t_e__i_d
	    Specifies the private data that the	application wants to store
	    with the data item.

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dCCooppyy((33XX)), XXmmCClliippbbooaarrddLLoocckk((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dUUnnlloocckk((33XX)).































































