


XmClipboardInquirePendingItems(3X)	   XmClipboardInquirePendingItems(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmCClliippbbooaarrddIInnqquuiirreePPeennddiinnggIItteemmss - A clipboard function	that returns a list
  of data_id/private_id	pairs

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dIInnqquuiirreePPeennddiinnggIItteemmss ((_d_i_s_p_l_a_y, _w_i_n_d_o_w, _f_o_r_m_a_t__n_a_m_e,
	    _i_t_e_m__l_i_s_t, _c_o_u_n_t))
       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;;
       cchhaarr		* _f_o_r_m_a_t__n_a_m_e;;
       XXmmCClliippbbooaarrddPPeennddiinnggLLiisstt* _i_t_e_m__l_i_s_t;;
       uunnssiiggnneedd	lloonngg	* _c_o_u_n_t;;

DESCRIPTION
  XXmmCClliippbbooaarrddIInnqquuiirreePPeennddiinnggIItteemmss returns a list	of _d_a_t_a__i_d/_p_r_i_v_a_t_e__i_d pairs
  for the specified format name.  A data item is considered pending if the
  application originally passed	it by name, the	application has	not yet
  copied the data, and the item	has not	been deleted from the clipboard.  The
  application is responsible for freeing the memory provided by	this function
  to store the list.  To free the memory, call XXttFFrreeee.

  This function	is used	by an application when exiting,	to determine if	the
  data that is passed by name should be	sent to	the clipboard.

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

  _f_o_r_m_a_t__n_a_m_e Specifies	a string that contains the name	of the format for
	      which the	list of	data ID/private	ID pairs is to be obtained.

  _i_t_e_m__l_i_s_t   Specifies	the address of the array of data ID/private ID pairs
	      for the specified	format name.  This argument is a type XXmmCClliipp--
	      bbooaarrddPPeennddiinnggLLiisstt.	 The application is responsible	for freeing
	      the memory provided by this function for storing the list.

  _c_o_u_n_t	      Specifies	the number of items returned in	the list.  If there
	      is no data for the specified format name,	or if there is no
	      item on the clipboard, this argument equals zero.




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dSSttaarrttCCooppyy((33XX)).


























































