home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cato / Xm / XmTextGetSubstring.z / XmTextGetSubstring
Encoding:
Text File  |  1998-10-20  |  6.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnngggg((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnngggg((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnngggg - A Text function that retrieves a copy
  10.           of a portion of the internal text buffer
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////TTTTeeeexxxxtttt....hhhh>>>>
  14.  
  15.           iiiinnnntttt XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnngggg ((((_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))))
  16.                WWWWiiiiddddggggeeeetttt      _w_i_d_g_e_t;;;;
  17.                XXXXmmmmTTTTeeeexxxxttttPPPPoooossssiiiittttiiiioooonnnn_s_t_a_r_t;;;;
  18.                iiiinnnntttt         _n_u_m__c_h_a_r_s;;;;
  19.                iiiinnnntttt         _b_u_f_f_e_r__s_i_z_e;;;;
  20.                cccchhhhaaaarrrr        ****_b_u_f_f_e_r;;;;
  21.  
  22.  
  23.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  24.           This page documents version 1.2 of the Motif library.
  25.  
  26.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  27.           XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnngggg retrieves a copy of a portion of the
  28.           internal text buffer of a Text widget.  The function copies
  29.           a specified number of characters from a given start position
  30.           in the internal text buffer into a buffer provided by the
  31.           application.  A NULL terminator is placed at the end of the
  32.           copied data.
  33.  
  34.           The size of the required buffer depends on the maximum
  35.           number of bytes per character (MMMMBBBB____CCCCUUUURRRR____MMMMAAAAXXXX) for the current
  36.           locale.  MMMMBBBB____CCCCUUUURRRR____MMMMAAAAXXXX is a macro defined in ssssttttddddlllliiiibbbb....hhhh.  The
  37.           buffer should be large enough to contain the substring to be
  38.           copied and a NULL terminator.  Use the following equation to
  39.           calculate the size of buffer the application should provide:
  40.  
  41.           _b_u_f_f_e_r__s_i_z_e = (_n_u_m__c_h_a_r_s * MMMMBBBB____CCCCUUUURRRR____MMMMAAAAXXXX) + 1
  42.  
  43.  
  44.           _w_i_d_g_e_t    Specifies the Text widget ID.
  45.  
  46.           _s_t_a_r_t     Specifies the beginning character position from
  47.                     which the data will be retrieved.  This is an
  48.                     integer number of characters from the beginning of
  49.                     the text buffer.  The first character position is
  50.                     0.
  51.  
  52.           _n_u_m__c_h_a_r_s Specifies the number of characters to be copied
  53.                     into the provided buffer.
  54.  
  55.           _b_u_f_f_e_r__s_i_z_e
  56.                     Specifies the size of the supplied buffer in
  57.                     bytes.  This size should account for a NULL
  58.                     terminator.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnngggg((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnngggg((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           _b_u_f_f_e_r    Specifies the character buffer into which the
  75.                     internal text buffer will be copied.
  76.  
  77.  
  78.           For a complete definition of Text and its associated
  79.           resources, see XXXXmmmmTTTTeeeexxxxtttt((((3333XXXX)))).
  80.  
  81.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  82.           XXXXmmmmCCCCOOOOPPPPYYYY____SSSSUUUUCCCCCCCCEEEEEEEEDDDDEEEEDDDD    The function was successful.
  83.  
  84.           XXXXmmmmCCCCOOOOPPPPYYYY____FFFFAAAAIIIILLLLEEEEDDDD       The function failed because it was
  85.                               unable to copy the specified number of
  86.                               characters into the buffer provided.
  87.                               The buffer size may be insufficient.
  88.                               The contents of _b_u_f_f_e_r are undefined.
  89.  
  90.           XXXXmmmmCCCCOOOOPPPPYYYY____TTTTRRRRUUUUNNNNCCCCAAAATTTTEEEEDDDD    The requested number of characters
  91.                               extended beyond the internal buffer.
  92.                               The function copied characters between
  93.                               _s_t_a_r_t and the end of the widget's buffer
  94.                               and terminated the string with a NULL
  95.                               terminator; fewer than _n_u_m__c_h_a_r_s
  96.                               characters were copied.
  97.  
  98.  
  99.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  100.           XXXXmmmmTTTTeeeexxxxtttt((((3333XXXX)))) and XXXXmmmmTTTTeeeexxxxttttGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX)))).
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.