RESOURCE Statement

Syntax:

  RESOURCE type-id resource-id [load-option] [mem-option]
           [code-page] filename

  or

  RESOURCE type-id resource-id [load-option] [mem-option]
           [code-page]
  BEGIN
  data-definition [, data-definition]...
  ...
  END

The RESOURCE statement defines a custom resource for an application. A custom resource can be any data in any format. The RESOURCE statement copies the custom resource from the specified file or inline data, and adds it to the application's other resources. A custom resource can be loaded from the executable file when needed by using the DosGetResource or DosGetResource2 function and specifying the resource's type and resource identifier.

The custom resource data can be defined in a separate file or as inline data in the input script. This is reflected in the two formats that can be used for this statement. The first format is used when the custom resource data is being read from a file. The second format is used when the data consists of a block of raw source data that is defined inline in the input script.

You can provide any number of RESOURCE statements in a resource script file, but each statement must specify a unique combination of type-id and resource-id values. That is, RESOURCE statements having the same type-id value are permitted as long as the resource-id value for each is unique.

type-id

Specifies the custom-resource type. This value must be an integer in the range 256 through 65535, or a simple expression that evaluates to a value in that range. (Values 0 through 255 are reserved.)
resource-id
Specifies the custom-resource identifier. This value must be a signed integer in the range -32768 through 32767, an unsigned integer in the range of 1 through 65535, a simple expression that evaluates to a value in these ranges, or a character string.
load-option
Specifies when the system loads the resource from the executable file into memory. This value must be one of the following: PRELOAD
System loads the resource when the application starts.
LOADONCALL
System loads the resource when the application calls the DosGetResource or DosGetResource2 function. This is the default option.
mem-option
Specifies how the system manages the resource when it is in memory. This value must be one or more of the following: FIXED
System keeps the resource at a fixed memory location.
MOVEABLE
System moves the resource as necessary to compact memory.
DISCARDABLE
System discards the resource if it is no longer needed. The default setting is MOVEABLE and DISCARDABLE.
codepage
Specifies a code page value. See CODEPAGE Statement. for a list of valid code pages.
filename
Specifies the name of the file containing the custom resource. If the file is not in the current directory, filename must be preceded by a full path.
data-definition
Specifies a custom data definition. The data can be a simple expression or a string. Integers can be specified in decimal, octal, or hexadecimal format. Data definitions in series on the same line are separated by commas. An integer specified without the suffix L must be in the range -32768 through 65535. An integer with an L suffix must be within the range -2147483648 through 4294967295. String data is specified withing quotes.

Note: The Resouce Compiler does not append a null character to the end of these strings as it does for RCDATA blocks; any required null characters must be written as \0 within the data string.

Example

This example defines a custom resource whose type identifier is 300 and whose resource identifier is 14. The custom resource is copied from the file CUSTOM.RES.

RESOURCE 300 14 custom.res

---

[Back: RCINCLUDE Statement]
[Next: RTEXT Statement]