


XmClipboardRegisterFormat(3X)			XmClipboardRegisterFormat(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmCClliippbbooaarrddRReeggiisstteerrFFoorrmmaatt - A	clipboard function that	registers a new	for-
  mat

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dRReeggiisstteerrFFoorrmmaatt	((_d_i_s_p_l_a_y, _f_o_r_m_a_t__n_a_m_e, _f_o_r_m_a_t__l_e_n_g_t_h))
       DDiissppllaayy	   * _d_i_s_p_l_a_y;;
       cchhaarr	   * _f_o_r_m_a_t__n_a_m_e;;
       iinntt	   _f_o_r_m_a_t__l_e_n_g_t_h;;

DESCRIPTION
  XXmmCClliippbbooaarrddRReeggiisstteerrFFoorrmmaatt registers a	new format.  Each format stored	on
  the clipboard	should have a length associated	with it; this length must be
  known	to the clipboard routines.  Formats are	known as targets in the
  _I_n_t_e_r-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l	(ICCCM).  All of the formats
  specified by the ICCCM conventions are preregistered.	 Any other format
  that the application wants to	use must either	be 8-bit data or be
  registered via this routine.	Failure	to register the	length of the data
  results in incompatible applications across platforms	having different
  byte-swapping	orders.

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

  _f_o_r_m_a_t__n_a_m_e	 Specifies the string name for the new format (target).

  _f_o_r_m_a_t__l_e_n_g_t_h	 Specifies the format length in	bits (8, 16, or	32).

RETURN VALUE

  CClliippbbooaarrddBBaaddFFoorrmmaatt
		 The _f_o_r_m_a_t__n_a_m_e must not be NULL, and the _f_o_r_m_a_t__l_e_n_g_t_h must
		 be 8, 16, or 32.

  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dFFaaiill	 The function failed because the format	was already
		 registered with this length.

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




