Get text resource
Get text resource ( resID : Integer {; resFile : Time} ) : Text
| Parameter | Type | Description | |
|---|---|---|---|
| resID | Integer | → | Resource ID number |
| resFile | Time | → | Resource file reference number, or all open resource files, if omitted |
| Function result | Text | ← | Contents of the TEXT resource |
History
| Release | Changes |
|---|---|
| 6 | Created |
Description
The Get text resource command returns the text stored in the text (“TEXT”) resource whose ID is passed in resID.
If the resource is not found, empty text 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 text resource can contain up to 32,000 characters.
Example
The following example displays the contents of the text resource ID=20800, which must be located in at least one of the currently open resource files:
ALERT(Get text resource(20800))
System variables and sets
If the resource is found, OK is set to 1. Otherwise, it is set to 0 (zero).
See also
Get indexed string
Get string resource
STRING LIST TO ARRAY
Properties
| Command number | 504 |
| Thread safe | no |
| Modifies variables | OK |