|
|
|
|
|
|
|
|
|
|
version 6.0
Get indexed string (resID; strID{; resFile}) 
String
| Parameter | Type | Description | |
| resID | Number | | Resource ID number |
| strID | Number | | String number |
| resFile | DocRef | | Resource file reference number, or |
| all open resource files, if omitted | |||
| Function result | String |  | Value of the indexed string |
Description
The Get indexed string command returns one of the strings stored in the string list ("STR#") resource whose ID is passed in resID.
You pass the number of the string in strID. The strings of a string list resource are numbered from 1 to N. To get all the strings (and their numbers) of a string list resource, use the command STRING LIST TO ARRAY.
If the resource or the string within the resource is not found, an empty string is returned and the OK variable is set to 0 (zero).
If you pass a valid resource file reference number in resFile, the resource is searched for in that file only. If you do not pass resFile, the first occurrence of the resource found in the resource files chain is returned.
Note: A string of a string list resource can contain up to 255 characters.
Example
See example for the command Month of.
See Also
Get string resource, Get text resource, STRING LIST TO ARRAY.
System Variables and Sets
If the resource is found, OK is set to 1. Otherwise, it is set to 0 (zero).
|
|
|
|
|
|
|
|
|
|