Get resource properties
Get resource properties ( resType : Text ; resID : Integer {; resFile : Time} ) : Integer
| Parameter | Type | Description | |
|---|---|---|---|
| resType | Text | → | 4-character resource type |
| resID | Integer | → | Resource ID number |
| resFile | Time | → | Resource file reference number, or all open resource files, if omitted |
| Function result | Integer | ← | Resource attributes |
History
| Release | Changes |
|---|---|
| 6 | Created |
Description
The Get resource properties command returns the attributes of the resource whose type is passed in resType and whose ID number is passed in resID.
If you pass a valid resource file reference number in the parameter resFile, the resource is searched for within that file only. If you do not pass the parameter resFile, the resource is searched for within the current open resource files.
If the resource does not exist, the command returns 0 (zero) and sets the OK variable to 0 (zero).
The numeric value returned by Get resource properties must be seen as a bit field value whose bits have special meaning.
Example
See example for the Get resource name command.
System variables and sets
The OK variable is set to 0 if the resource does not exist; otherwise, it is set to 1.
Properties
| Command number | 515 |
| Thread safe | no |
| Modifies variables | OK |