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 / XmTextFieldGetSubstringWcs.z / XmTextFieldGetSubstringWcs
Encoding:
Text File  |  1998-10-20  |  6.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmTTTTVVVVeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss - A TextField function that
  10.           retrieves a a portion of a wide character internal text
  11.           buffer
  12.  
  13.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////TTTTeeeexxxxttttFFFF....hhhh>>>>
  15.  
  16.           iiiinnnntttt XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss ((((_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))))
  17.                WWWWiiiiddddggggeeeetttt      _w_i_d_g_e_t;;;;
  18.                XXXXmmmmTTTTeeeexxxxttttPPPPoooossssiiiittttiiiioooonnnn_s_t_a_r_t;;;;
  19.                iiiinnnntttt         _n_u_m__c_h_a_r_s;;;;
  20.                iiiinnnntttt         _b_u_f_f_e_r__s_i_z_e;;;;
  21.                wwwwcccchhhhaaaarrrr____tttt     ****_b_u_f_f_e_r;;;;
  22.  
  23.  
  24.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  25.           This page documents version 1.2 of the Motif library.
  26.  
  27.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  28.           XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss retrieves a copy of a portion of
  29.           the internal text buffer of a TextField widget that is
  30.           stored in a wide character format.  The function copies a
  31.           specified number of characters from a given start position
  32.           in the internal text buffer into a buffer provided by the
  33.           application.  A NULL terminator is placed at the end of the
  34.           copied data.
  35.  
  36.  
  37.           _w_i_d_g_e_t    Specifies the TextField widget ID.
  38.  
  39.           _s_t_a_r_t     Specifies the beginning character position from
  40.                     which the data will be retrieved.  This is an
  41.                     integer number of characters from the beginning of
  42.                     the text buffer.  The first character position is
  43.                     0.
  44.  
  45.           _n_u_m__c_h_a_r_s Specifies the number of wwwwcccchhhhaaaarrrr____tttt characters to be
  46.                     copied into the provided buffer.
  47.  
  48.           _b_u_f_f_e_r__s_i_z_e
  49.                     Specifies the size of the supplied buffer as a
  50.                     number of wwwwcccchhhhaaaarrrr____tttt storage locations.  The minimum
  51.                     size is _n_u_m__c_h_a_r_s + 1.
  52.  
  53.           _b_u_f_f_e_r    Specifies the wide character buffer into which the
  54.                     internal text buffer will be copied.
  55.  
  56.  
  57.           For a complete definition of TextField and its associated
  58.           resources, see XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeelllldddd((((3333XXXX)))).
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmTTTTVVVVeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX))))
  71.  
  72.  
  73.  
  74.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  75.           XXXXmmmmCCCCOOOOPPPPYYYY____SSSSUUUUCCCCCCCCEEEEEEEEDDDDEEEEDDDD    The function was successful.
  76.  
  77.           XXXXmmmmCCCCOOOOPPPPYYYY____FFFFAAAAIIIILLLLEEEEDDDD       The function failed because it was
  78.                               unable to copy the specified number of
  79.                               characters into the buffer provided.
  80.                               The buffer size may be insufficient.
  81.                               The contents of _b_u_f_f_e_r are undefined.
  82.  
  83.           XXXXmmmmCCCCOOOOPPPPYYYY____TTTTRRRRUUUUNNNNCCCCAAAATTTTEEEEDDDD    The requested number of characters
  84.                               extended beyond the internal buffer.
  85.                               The function copied characters to the
  86.                               end of the buffer and terminated the
  87.                               string with a NULL terminator; fewer
  88.                               than _n_u_m__c_h_a_r_s characters were copied.
  89.  
  90.  
  91.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  92.           XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeelllldddd((((3333XXXX)))) and XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnngggg((((3333XXXX)))).
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  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.