


XmTextGetSubstringWcs(3X)			    XmTextGetSubstringWcs(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmTTeexxttGGeettSSuubbssttrriinnggWWccss	- A Text function that retrieves a portion of a	wide
  character internal text buffer

SYNOPSIS


  ##iinncclluuddee <<XXmm//TTeexxtt..hh>>
  iinntt XXmmTTeexxttGGeettSSuubbssttrriinnggWWccss ((_w_i_d_g_e_t, _s_t_a_r_t, _n_u_m__c_h_a_r_s, _b_u_f_f_e_r__s_i_z_e,
	  _b_u_f_f_e_r))
       WWiiddggeett	   _w_i_d_g_e_t;;
       XXmmTTeexxttPPoossiittiioonn_s_t_a_r_t;;
       iinntt	   _n_u_m__c_h_a_r_s;;
       iinntt	   _b_u_f_f_e_r__s_i_z_e;;
       wwcchhaarr__tt	   **_b_u_f_f_e_r;;

DESCRIPTION
  XXmmTTeexxttGGeettSSuubbssttrriinnggWWccss	retrieves a copy of a portion of the internal text
  buffer of a Text widget that is stored in a wide character format.  The
  function copies a specified number of	characters from	a given	start posi-
  tion in the internal text buffer into	a buffer provided by the application.
  A NULL terminator is placed at the end of the	copied data.

  _w_i_d_g_e_t    Specifies the Text widget ID.

  _s_t_a_r_t	    Specifies the beginning character position from which the data
	    will be retrieved.	This is	an integer number of characters	from
	    the	beginning of the text buffer.  The first character position
	    is 0.

  _n_u_m__c_h_a_r_s Specifies the number of wwcchhaarr__tt characters to be copied into the
	    provided buffer.

  _b_u_f_f_e_r__s_i_z_e
	    Specifies the size of the supplied buffer as a number of wwcchhaarr__tt
	    storage locations.	The minimum size is _n_u_m__c_h_a_r_s +	1.

  _b_u_f_f_e_r    Specifies the wide character buffer	into which the internal	text
	    buffer will	be copied.

  For a	complete definition of Text and	its associated resources, see
  XXmmTTeexxtt((33XX)).

RETURN VALUE

  XXmmCCOOPPYY__SSUUCCCCEEEEDDEEDD    The function was successful.

  XXmmCCOOPPYY__FFAAIILLEEDD	      The function failed because it was unable	to copy	the
		      specified	number of characters into the buffer pro-
		      vided.  The buffer size may be insufficient.  The	con-
		      tents of _b_u_f_f_e_r are undefined.

  XXmmCCOOPPYY__TTRRUUNNCCAATTEEDD    The requested number of characters extended beyond the
		      internal buffer.	The function copied characters
		      between _s_t_a_r_t and	the end	of the widget's	buffer and
		      terminated the string with a NULL	terminator; fewer
		      than _n_u_m__c_h_a_r_s characters	were copied.

RELATED	INFORMATION
  XXmmTTeexxtt((33XX)) and XXmmTTeexxttGGeettSSuubbssttrriinngg((33XX)).
































































