


XmClipboardInquireLength(3X)			 XmClipboardInquireLength(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmCClliippbbooaarrddIInnqquuiirreeLLeennggtthh - A clipboard function that returns the length of
  the stored data

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eLLeennggtthh ((_d_i_s_p_l_a_y, _w_i_n_d_o_w, _f_o_r_m_a_t__n_a_m_e, _l_e_n_g_t_h))
       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;;
       uunnssiiggnneedd	lloonngg* _l_e_n_g_t_h;;

DESCRIPTION
  XXmmCClliippbbooaarrddIInnqquuiirreeLLeennggtthh returns the length of the data stored under a
  specified format name	for the	clipboard data item.  If no data is found for
  the specified	format,	or if there is no item on the clipboard, this func-
  tion returns a value of zero.

  Any format passed by name is assumed to have the _l_e_n_g_t_h passed in a call to
  XXmmCClliippbbooaarrddCCooppyy, even	though the data	has not	yet been transferred to	the
  clipboard in that format.

  _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	the name of the	format for the data item.

  _l_e_n_g_t_h      Specifies	the length of the next data item in the	specified
	      format.  This argument equals zero if no data is found for the
	      specified	format,	or if there is no item on the clipboard.

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dNNooDDaattaa
	      The function could not find data on the clipboard	corresponding
	      to the format requested.	This could occur because the clip-
	      board 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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)).































































