Get string resource
Get string resource ( resID {; resFile} ) : 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 STR resource |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The Get string resource command returns the string stored in the string (“STR ”) resource whose ID is passed in resID.
If 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 resource can contain up to 255 characters.
Example
The following example displays the contents of the string resource ID=20911, which must be located in at least one of the currently open resource files:
ALERT(Get string resource(20911))
System variables and sets
If the resource is found, OK is set to 1. Otherwise, it is set to 0 (zero).