STRING LIST TO ARRAY

4D - Documentation   Français   English   German   4th Dimension 2004, Command Theme List   4th Dimension 2004, Command Alphabetical List   4th Dimension 2004, Constant Theme List   Back   Previous   Next

version 6.0


STRING LIST TO ARRAY (resID; strings{; resFile})

ParameterTypeDescription
resIDNumberResource ID number
stringsString arrayString or Text array to receive the strings
Strings from the STR# resource
resFileDocRefResource file reference number, or
all open resource files, if omitted

Description

The STRING LIST TO ARRAY command populates the array strings with the strings stored in the string list ("STR#") resource whose ID is passed in resID.

If the resource is not found, the array strings is left unchanged 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.

Before calling STRING LIST TO ARRAY, you can predeclare the array strings as a String or Text array. If you do not predeclare the array, the command creates strings as a Text array.

Note: Each string of a string list resource can contain up to 255 characters.

Tip: Limit your use of string list resources to those up to 32K in total size, and a maximum of a few hundred strings per resource.

Example

See example for the command ARRAY TO STRING LIST.

See Also

ARRAY TO STRING LIST, Get indexed string, Get string resource, Get text resource.

System Variables and Sets

If the resource is found, OK is set to 1. Otherwise, it is set to 0 (zero).


4D - Documentation   Français   English   German   4th Dimension 2004, Command Theme List   4th Dimension 2004, Command Alphabetical List   4th Dimension 2004, Constant Theme List   Back   Previous   Next