home *** CD-ROM | disk | FTP | other *** search
/ Really Useful CD 1 / ReallyUsefulCD1.iso / extras / progutils / baslib / baslibdoc / stringlib < prev    next >
Encoding:
Text File  |  1989-03-15  |  4.3 KB  |  166 lines
  1. Routine   : FNstrip_trailing(string$,char$)      
  2. Library   : StringLib
  3. Purpose   : Strips any number of the specified 
  4.             character from the right hand end of 
  5.             the given string.
  6. Source    : User
  7. Author    : Paul Hobbs
  8. Parameters:
  9.    string$  = the string to operate on
  10.    char$    = the character to strip off    
  11. Dependant Routines:
  12.    None
  13. Global Variables: 
  14.    None 
  15. Notes: 
  16.    None 
  17. Routine   : FNstrip_leading(string$,char$)
  18. Library   : StringLib
  19. Purpose   : Strips any number of the specified 
  20.             character from the left hand end of 
  21.             the given string.
  22. Source    : User
  23. Author    : Paul Hobbs
  24. Parameters:
  25.    string$  = the string to operate on
  26.    char$    = the character to strip off 
  27. Dependant Routines:
  28.    None
  29. Global Variables:
  30.    None 
  31. Notes: 
  32.    None 
  33. Routine   : FNpad_trailing(string$,char$,
  34.             length%)
  35. Library   : StringLib
  36. Purpose   : Pads the right hand end of the given 
  37.             string with the character specified to 
  38.             the required length. 
  39. Source    : User
  40. Author    : Paul Hobbs
  41. Parameters:
  42.    string$  = the string to operate on
  43.    char$    = the character to use to pad the 
  44.               string
  45.    length%  = the length of the resultant string 
  46. Dependant Routines:
  47.    None
  48. Global Variables:
  49.    None 
  50. Notes: 
  51.    None   
  52. Routine   : FNpad_leading(string$,char$,
  53.             length%)
  54. Library   : StringLib
  55. Purpose   : Pads the left hand end of the given 
  56.             string with the character specified to 
  57.             the required  length.
  58. Source    : User
  59. Author    : Paul Hobbs
  60. Parameters:
  61.    string$  = the string to operate on
  62.    char$    = the character to use to pad the 
  63.               string
  64.    length%  = the length of the resultant string 
  65. Dependant Routines:
  66.    None
  67. Global Variables:
  68.    None 
  69. Notes: 
  70.    None
  71. Routine   : FNupper_case(string$)
  72. Library   : StringLib
  73. Purpose   : Converts the specified string to 
  74.             upper case. 
  75. Source    : User
  76. Author    : Paul Hobbs
  77. Parameters:
  78.    string$  = the string to operate on
  79. Dependant Routines:
  80.    None
  81. Global Variables:
  82.    None 
  83. Notes: 
  84.    None   
  85. Routine   : FNlongest(array$(),nr%)
  86. Library   : StringLib
  87. Purpose   : Returns the length of the longest 
  88.             element of the specified string array. 
  89. Source    : User
  90. Author    : Paul Hobbs
  91. Parameters:
  92.    array$() = the string array to operate on
  93.    nr%      = the highest numbered element of the 
  94.               array to consider
  95. Dependant Routines:
  96.    None
  97. Global Variables:
  98.    None 
  99. Notes: 
  100.    None
  101. Routine   : FNmem_to_string(block%,offset%, 
  102.             term%) 
  103. Library   : StringLib
  104. Purpose   : Reads a string from a block of memory 
  105.             terminated by the character term%. 
  106. Source    : User
  107. Author    : Paul Hobbs
  108. Parameters:
  109.    block%   = the start address of the 
  110.               memory block 
  111.    offset%  = the pointer offset within the 
  112.               block
  113.    term%    = the ASCII code of the terminating 
  114.               character
  115. Dependant Routines:
  116.    None
  117. Global Variables:
  118.    None 
  119. Notes: 
  120.    The routine returns a string which has been 
  121.    extracted from the memory block + the pointer 
  122.    offset terminated by the term% character. Note 
  123.    that in the main program it may be necessary to 
  124.    update the pointer position with ptr% += 
  125.    LEN(string$)+1 if the routine is used 
  126.    repeatedly.
  127. Routine   : FNstring_exchange(string$,target$, 
  128.             sub$)
  129. Library   : StringLib
  130. Purpose   : Searches the string and replaces any 
  131.             occurrence of target$ with sub$
  132. Source    : User
  133. Author    : Paul Hobbs
  134. Parameters:
  135.    string$  = the string to operate on
  136.    target$  = the string to be replaced
  137.    sub$     = the replacing string
  138. Dependant Routines:
  139.    None
  140. Global Variables:
  141.    None 
  142. Notes: 
  143.    The target and replacing strings do not have to 
  144.    be the same length - but no check is made to 
  145.    see if a string would be created which is 
  146.    longer than 255 characters. The case of the 
  147.    target string is taken into consideration when 
  148.    matching. If the target string is not found 
  149.    then no action is taken.
  150. Routine   : FNstrip_all(string$,char$)
  151. Library   : StringLib
  152. Purpose   : Strips any number of the specified 
  153.             character from anywhere within the 
  154.             given string 
  155. Source    : User
  156. Author    : Paul Hobbs
  157. Parameters:
  158.    string$  = the string to operate on
  159.    char$    = the character to strip off 
  160. Dependant Routines:
  161.    None
  162. Global Variables:
  163.    None 
  164. Notes: 
  165.    None 
  166.