| Note | This command is defined in a header file and will be preprocessed by the X# preprocessor to a function call. If you disable the standard header (-nostddefs) files then this command will not be available. If you tell the compiler to use a different standard header file (-stddef ) then this command may also be not available |
Purpose
Copies data from the currently selected table to an array.
Syntax
COPY TO ARRAY <ArrayName>
[FIELDS FieldList | FIELDS LIKE <Skeleton> | FIELDS EXCEPT <Skeleton>]
[<Scope>] [WHILE <lCondition>] [FOR <lCondition>] [NOOPTIMIZE]
Arguments
| <ArrayName> | Specifies the name of the array that contains the data to be copied to the new records. New records are added to the table until all rows in the array are appended. |
| FIELDS <idFieldList> | The list of fields to process. The default is all fields with the exception of memo fields, unless the command supports the MEMO clause. |
| Only fields with the same names and types in both files are appended. If fields with the same name do not match in data type, a runtime error is raised. |
| FIELDS LIKE <Skeleton> | You can specify field names with a wild card, such as FIELDS LIKE *name |
| FIELDS EXCEPT <Skeleton> | You can exclude fields, such as for example the primary keys: FIELDS EXCEPT Id <Skeleton> supports wildcards (* and ?). For example, to replace all fields that begin with the letters A and P, use: FIELDS LIKE A*,P* |
Please note that you can combine FIELDS LIKE and FIELDS EXCEPT but you cannot combine a fields list with the LIKE and EXCEPT clauses.
| <Scope> | The portion of the current database file to process. The default is all visible records. Scope is one or more clauses of: [NEXT <NEXT>] Optionally specifies the number of records to process starting with the first record of the source file. [RECORD <rec>] An optional record ID If specified, the processing begins with this data record in the source file. [<rest:REST>] The option REST specifies whether records are sequentially searched only from the current up to the last record. If a condition is specified, the option ALL is the default value. [ALL] The option ALL specifies that all records from the source file are imported. This is the default setting. |
| WHILE <lCondition> | A condition that each visible record within the scope must meet, starting with the current record. As soon as the while condition fails, the process terminates. If no <Scope> is specified, having a while condition changes the default scope to the rest of the visible records in the file. |
| FOR <lCondition> | A condition that each visible record within the scope must meet in order to be processed. If a record does not meet the specified condition, it is ignored and the next visible record is processed. If no <Scope> or WHILE clause is specified, having a for condition changes the default scope to all visible records. |
| NOOPTIMIZE | This clause is parsed but not yet supported. |
See Also
