


XmClipboardLock(3X)					  XmClipboardLock(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmCClliippbbooaarrddLLoocckk - A clipboard	function that locks 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dLLoocckk ((_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dLLoocckk locks	the clipboard from access by another application
  until	XXmmCClliippbbooaarrddUUnnlloocckk is called.  All clipboard functions lock and unlock
  the clipboard	to prevent simultaneous	access.	 This function allows the
  application to keep the clipboard data from changing between calls to
  IInnqquuiirree and other clipboard functions.  The application does not need	to
  lock the clipboard between calls to XXmmCClliippbbooaarrddSSttaarrttCCooppyy and XXmmCClliippbbooaarr--
  ddEEnnddCCooppyy or to 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 and XXmmCClliippbbooaarrddEEnnddRReettrriieevvee.

  If the clipboard is already locked by	another	application, XXmmCClliippbbooaarrddLLoocckk
  returns an error status.  Multiple calls to this function by the same
  application increases	the lock level.

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








