


XmStringGetNextComponent(3X)			 XmStringGetNextComponent(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmSSttrriinnggGGeettNNeexxttCCoommppoonneenntt - A compound	string function	that returns the type
  and value of the next	component in a compound	string

SYNOPSIS


  ##iinncclluuddee <<XXmm//XXmm..hh>>
  XXmmSSttrriinnggCCoommppoonneennttTTyyppee	XXmmSSttrriinnggGGeettNNeexxttCCoommppoonneenntt ((_c_o_n_t_e_x_t, _t_e_x_t, _t_a_g,
	    _d_i_r_e_c_t_i_o_n, _u_n_k_n_o_w_n__t_a_g, _u_n_k_n_o_w_n__l_e_n_g_t_h, _u_n_k_n_o_w_n__v_a_l_u_e))
       XXmmSSttrriinnggCCoonntteexxtt	   _c_o_n_t_e_x_t;;
       cchhaarr		   ****_t_e_x_t;;
       XXmmSSttrriinnggCChhaarrSSeett	   **_t_a_g;;
       XXmmSSttrriinnggDDiirreeccttiioonn   **_d_i_r_e_c_t_i_o_n;;
       XXmmSSttrriinnggCCoommppoonneennttTTyyppee**_u_n_k_n_o_w_n__t_a_g;;
       uunnssiiggnneedd	sshhoorrtt	   **_u_n_k_n_o_w_n__l_e_n_g_t_h;;
       uunnssiiggnneedd	cchhaarr	   ****_u_n_k_n_o_w_n__v_a_l_u_e;;

DESCRIPTION
  XXmmSSttrriinnggGGeettNNeexxttCCoommppoonneenntt returns the type and	value of the next component
  in the compound string identified by _c_o_n_t_e_x_t.	 It is a low-level component
  function.  Components	are returned one at a time.  On	return,	only some
  output parameters will be valid; which ones can be determined	by examining
  the return status.  In the case of _t_e_x_t, _t_a_g,	and _d_i_r_e_c_t_i_o_n components,
  only one output parameter is valid.  If the return status indicates an unk-
  nown component was encountered, the font list	element	tag, length, and
  value	are returned.  This function allocates the space necessary to hold
  returned values; freeing this	space is the caller's responsibility.

  _c_o_n_t_e_x_t     Specifies	the string context structure which was allocated by
	      the XXmmSSttrriinnggIInniittCCoonntteexxtt function.

  _t_e_x_t	      Specifies	a pointer to a null terminated string.

  _t_a_g	      Specifies	a pointer to the font list element tag associated
	      with the text.  The value	XXmmFFOONNTTLLIISSTT__DDEEFFAAUULLTT__TTAAGG identifies a
	      locale text segment.

  _d_i_r_e_c_t_i_o_n   Specifies	a pointer to the direction of the text.

  _u_n_k_n_o_w_n__t_a_g Specifies	a pointer to the tag of	an unknown component.

  _u_n_k_n_o_w_n__l_e_n_g_t_h
	      Specifies	a pointer to the length	of an unknown component.

  _u_n_k_n_o_w_n__v_a_l_u_e
	      Specifies	a pointer to the value of an unknown component.






RETURN VALUE
  Returns the type of component	found.	Following are the possible values:

    oo++  XXmmSSTTRRIINNGG__CCOOMMPPOONNEENNTT__CCHHAARRSSEETT
       This component is obsolete and remains for compatibility	with previous
       releases.  It has been replaced by
       XXmmSSTTRRIINNGG__CCOOMMPPOONNEENNTT__FFOONNTTLLIISSTT__EELLEEMMEENNTT__TTAAGG.

    oo++  XXmmSSTTRRIINNGG__CCOOMMPPOONNEENNTT__FFOONNTTLLIISSTT__EELLEEMMEENNTT__TTAAGG

    oo++  XXmmSSTTRRIINNGG__CCOOMMPPOONNEENNTT__LLOOCCAALLEE__TTEEXXTT

    oo++  XXmmSSTTRRIINNGG__CCOOMMPPOONNEENNTT__TTAAGG

    oo++  XXmmSSTTRRIINNGG__CCOOMMPPOONNEENNTT__TTEEXXTT

    oo++  XXmmSSTTRRIINNGG__CCOOMMPPOONNEENNTT__DDIIRREECCTTIIOONN

    oo++  XXmmSSTTRRIINNGG__CCOOMMPPOONNEENNTT__SSEEPPAARRAATTOORR

    oo++  XXmmSSTTRRIINNGG__CCOOMMPPOONNEENNTT__EENNDD

    oo++  XXmmSSTTRRIINNGG__CCOOMMPPOONNEENNTT__UUNNKKNNOOWWNN

RELATED	INFORMATION
  XXmmSSttrriinnggCCrreeaattee((33XX)) and XXmmSSttrriinnggIInniittCCoonntteexxtt((33XX)).













































