


XmClipboardInquireFormat(3X)			 XmClipboardInquireFormat(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmCClliippbbooaarrddIInnqquuiirreeFFoorrmmaatt - A clipboard function that returns a specified
  format 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dIInnqquuiirreeFFoorrmmaatt ((_d_i_s_p_l_a_y, _w_i_n_d_o_w, _i_n_d_e_x,
	    _f_o_r_m_a_t__n_a_m_e__b_u_f, _b_u_f_f_e_r__l_e_n, _c_o_p_i_e_d__l_e_n))
       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;;
       iinntt	  _i_n_d_e_x;;
       XXttPPooiinntteerr  _f_o_r_m_a_t__n_a_m_e__b_u_f;;
       uunnssiiggnneedd	lloonngg_b_u_f_f_e_r__l_e_n;;
       uunnssiiggnneedd	lloonngg* _c_o_p_i_e_d__l_e_n;;

DESCRIPTION
  XXmmCClliippbbooaarrddIInnqquuiirreeFFoorrmmaatt returns a specified format name for the data	item
  in the clipboard.  If	the name must be truncated, the	function returns a
  warning status.

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

  _i_n_d_e_x	       Specifies which of the ordered format names to obtain.  If
	       this index is greater than the number of	formats	for the	data
	       item, this function returns a zero in the _c_o_p_i_e_d__l_e_n argument.

  _f_o_r_m_a_t__n_a_m_e__b_u_f
	       Specifies the buffer that receives the format name.

  _b_u_f_f_e_r__l_e_n   Specifies the number of bytes in	the format name	buffer.

  _c_o_p_i_e_d__l_e_n   Specifies the number of bytes in	the string copied to the
	       buffer.	If this	argument equals	zero, there is no _n_t_h format
	       for 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.



  CClliippbbooaarrddTTrruunnccaattee
	       The data	returned is truncated because the user did not pro-
	       vide a buffer large enough to hold the data.

  CClliippbbooaarrddNNooDDaattaa
	       The function could not find data	on the clipboard correspond-
	       ing to the format requested.  This could	occur because the
	       clipboard is empty; there is data on the	clipboard but not in
	       the requested format; or	the data in the	requested format was
	       passed by name and is no	longer available.

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




















































