<Source>.CopyRecord (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Using the lists of items

Array items

Errors that do not modify the destination record

See also

<Source>.CopyRecord (Function)

In french: <Source>.CopieEnreg

Not available with this kind of connection

Copies:

the content of current record (loaded in memory) into the current record of a data file.
Versions 19 and later
the content of a Record variable into the current data file record.
New in version 19
the content of a Record variable into the current data file record.
the content of a Record variable into the current data file record. The source data file and the destination data file do not necessarily have the same structure. Only the stored data of destination data file is modified. The destination data file will be modified when saving the current record.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 26 and later

The syntax for handling a variable of type Record is now available.

New in version 26

The syntax for handling a variable of type Record is now available.

Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Example

Customer.ReadFirst(Name)
WHILE Customer.Out() = False
// Adds the record to the data file Customer2
Customer2.CopyRecord(Customer, hDefaultVal)
Customer2.Add()
// Goes to the next record
Customer.ReadNext(Name)
END

// Copy records from the Orders data file to an archive file
Orders_2019 is Data Source

// Create the archive file
Orders.Alias(Orders_2019)
Orders_2019.ChangeName("Orders_2019")
Orders_2019.Creation()

// Archive the orders
FOR EACH Orders where OrderDate = "20190101" TO "20191231"
// Adds the record into the archive file
Orders_2019.CopyRecord(Orders, hDefaultVal)
Orders_2019.Add()
END

Syntax

Copying the current record Hide the details

<Result> = <Destination data file>.CopyRecord(<Source> [, <Destination item> [, <Source item>]] [, <Options>])

<Result>: Boolean

True if the copy was performed,
False if an error occurred. HError is used to identify the error.

<Destination data file>: Control name

Name of destination data file to use. The data will be copied into the current record of this data file.

<Source>: Type corresponding to the specified source

Name of source data file to use. The current record of this data file contains the information that must be copied.

<Destination item>: Optional character string (with quotes)

List of items found in the destination data file that must be assigned with the values read in the current record of source data file. The items must be separated by a comma or by a CR character (Carriage Return).
Remark: The composite keys cannot be defined as destination items. They will be automatically assigned.
This parameter is ignored.

<Source item>: Optional character string (with quotes)

List of items found in the source data file that must be copied into the current record of destination data file. The items must be separated by a comma or by a CR character (Carriage Return). These items must be classified according to the order in which they will be assigned in the destination items. The composite keys must be excluded from this list.
This parameter is ignored.

<Options>: Constant or combination of constants (optional)

Configures the copy:
hCopyAutoId Copies the automatic identifier while keeping its value.
Remark: The use of this constant implies the use of the constant hSetIdAuto in the following function <Source>.Add.
hDefaultVal The items of destination record that are not affected by the copy are initialized with their default value (defined in the data model editor).

If no parameter is specified, the automatic identifier is not copied and the unmodified items of destination record are not initialized.
This parameter is ignored.

Copying the record found in a Record variable Hide the details

<Result> = <Destination data file>.CopyRecord(<Source record> [, <Destination item> [, <Source item>]] [, <Options>])

<Result>: Boolean

True if the copy was performed,
False if an error occurred. HError is used to identify the error.

<Destination data file>: Character string (with or without quotes)

Name of destination data file to use. The data will be copied into the current record of this data file.

<Source record>: Record variable

Name of Record variable containing the information to copy.

<Destination item>: Optional character string (with quotes)

List of items found in the destination data file that must be assigned with the values read in the current record of source data file. The items must be separated by a comma or by a CR character (Carriage Return).
Remark: The composite keys cannot be defined as destination items. They will be automatically assigned.
This parameter is ignored.

<Source item>: Optional character string (with quotes)

List of items found in the source data file that must be copied into the current record of destination data file. The items must be separated by a comma or by a CR character (Carriage Return). These items must be classified according to the order in which they will be assigned in the destination items. The composite keys must be excluded from this list.
This parameter is ignored.

<Options>: Constant or combination of constants (optional)

Configures the copy:
hCopyAutoId Copies the automatic identifier while keeping its value.
Remark: The use of this constant implies the use of the constant hSetIdAuto in the following function <Source>.Add.
hDefaultVal The items of destination record that are not affected by the copy are initialized with their default value (defined in the data model editor).

If no parameter is specified, the automatic identifier is not copied and the unmodified items of destination record are not initialized.
This parameter is ignored.

Remarks

The copied values

The items whose name is common to both records are copied (and converted if necessary).

The items of the source record that do not exist in the destination record are not copied.

The items of the destination record that do not exist in the source record are not modified (except if the hDefaultVal constant is specified).

When copying an item whose value is NULL, the copied item is initialized to empty (empty string ("") for the strings and 0 for the numeric values) if the NULL value is not supported by the destination data file.

Remark: When the assignments are performed between different types of items, the type conversions follow the WLanguage standards.

Using the lists of items

Specifying two lists of items allows you to assign items with different names. The items are assigned in the order in which they appear in the lists.

If none of the two lists of items is supplied, only the items whose name is common to both records are copied.

If only the list of the destination items (<Destination item>) is specified, only the specified items will be copied.

Array items

When handling the array items, <Source>.CopyRecord copies the maximum number of elements (starting from the first one).

If the array of the "source" record contains more elements than the array of the "destination" record, the additional elements of the "source" record are not copied.

If the array of the "source" record contains less elements than the array of the "destination" record, the additional elements of the "destination" record are not modified, except if the hDefaultVal constant is specified.

Errors that do not modify the destination record

The following errors do not modify the destination record:

no list is supplied and no item name is common to the two data files.
the list of items of a data file contains an item name that does not exist this data file.
the list of destination items contains a name of "composite key" item.
the list of destination items contains a name of "automatic identifier" item while the hCopyAutoId constant is not specified.
two lists of different sizes are specified.

Component: wd260hf.dll