HRetrieveRecord (Function)

// Retrieves the string containing the entire record
MyRecord is string = HRetrieveRecord(CUSTOMER)
// Extracts the last name of the customer
CustomerLastName is string = ExtractString(MyRecord, 1)
// Extracts the first name of the customer
CustomerFirstName is string = ExtractString(MyRecord, 2)

Syntax

Retrieving the content of a record for the specified file Hide the details

<Result> = HRetrieveRecord([<File name> [, <Item separator> [, <Array separator> [, <Format>]]]])

<Result>: Character string

Value of the record, in the following format:
<Content of item 1> + <Item separator> + <Content of item 2> + ...
The contents of items are extracted according to the physical order of items in the data file. If the item corresponds to NULL, <Content of item> corresponds to an empty string ("").
Depending on the specified <Format>, this character string is in ANSI format (default) or Unicode format.

<File name>: Optional character string (with or without quotes)

Name of the data file (view or query) used. If this name is not specified, HRetrieveRecord handles the last data file used by the last function for HFSQL management (starting with the letter H).

<Item separator>: Optional character string (with quotes)

Character string used to separate the different items in <Result>. The default separator is TAB.

<Array separator>: Optional character string (with quotes)

Character string used to separate the values of array items (or sub-items) in <Result>. The default separator is TAB.
Caution: for backward compatibility wit WINDEV 5.5, the separators are not indicated when the array items are empty.

<Format>: Optional Integer constant

Format used to return the value of the record. By default, an ANSI format character string is returned. To get a Unicode format string, use the following constant:
hUnicode <Result> is a Unicode character string.

Versions 19 and later

Retrieving the content of a record for the specified Record variable Hide the details

<Result> = HRetrieveRecord(<Record> [, <Item separator> [, <Array separator> [, <Format>]]])

<Result>: Character string

Value of the record, in the following format:
<Content of item 1> + <Item separator> + <Content of item 2> + ...
The contents of items are extracted according to the physical order of items in the data file. If the item corresponds to NULL, <Content of item> corresponds to an empty string ("").
Depending on the specified <Format>, this character string is in ANSI format (default) or Unicode format.

<Record>: Optional Record variable

Name of Record variable used.

<Item separator>: Optional character string (with quotes)

Character string used to separate the different items in <Result>. The default separator is TAB.

<Array separator>: Optional character string (with quotes)

Character string used to separate the values of array items (or sub-items) in <Result>. The default separator is TAB.
Caution: for backward compatibility wit WINDEV 5.5, the separators are not indicated when the array items are empty.

<Format>: Optional Integer constant

Format used to return the value of the record. By default, an ANSI format character string is returned. To get a Unicode format string, use the following constant:
hUnicode <Result> is a Unicode character string.

New in version 19

Retrieving the content of a record for the specified Record variable Hide the details

<Result> = HRetrieveRecord(<Record> [, <Item separator> [, <Array separator> [, <Format>]]])

<Result>: Character string

Value of the record, in the following format:
<Content of item 1> + <Item separator> + <Content of item 2> + ...
The contents of items are extracted according to the physical order of items in the data file. If the item corresponds to NULL, <Content of item> corresponds to an empty string ("").
Depending on the specified <Format>, this character string is in ANSI format (default) or Unicode format.

<Record>: Optional Record variable

Name of Record variable used.

<Item separator>: Optional character string (with quotes)

Character string used to separate the different items in <Result>. The default separator is TAB.

<Array separator>: Optional character string (with quotes)

Character string used to separate the values of array items (or sub-items) in <Result>. The default separator is TAB.
Caution: for backward compatibility wit WINDEV 5.5, the separators are not indicated when the array items are empty.

<Format>: Optional Integer constant

Format used to return the value of the record. By default, an ANSI format character string is returned. To get a Unicode format string, use the following constant:
hUnicode <Result> is a Unicode character string.

Retrieving the content of a record for the specified Record variable Hide the details

<Result> = HRetrieveRecord(<Record> [, <Item separator> [, <Array separator> [, <Format>]]])

<Result>: Character string

Value of the record, in the following format:
<Content of item 1> + <Item separator> + <Content of item 2> + ...
The contents of items are extracted according to the physical order of items in the data file. If the item corresponds to NULL, <Content of item> corresponds to an empty string ("").
Depending on the specified <Format>, this character string is in ANSI format (default) or Unicode format.

<Record>: Optional Record variable

Name of Record variable used.

<Item separator>: Optional character string (with quotes)

Character string used to separate the different items in <Result>. The default separator is TAB.

<Array separator>: Optional character string (with quotes)

Character string used to separate the values of array items (or sub-items) in <Result>. The default separator is TAB.
Caution: for backward compatibility wit WINDEV 5.5, the separators are not indicated when the array items are empty.

<Format>: Optional Integer constant

Format used to return the value of the record. By default, an ANSI format character string is returned. To get a Unicode format string, use the following constant:
hUnicode <Result> is a Unicode character string.

Remarks

The content of Binary Memo items is not retrieved but the item separator is present (to avoid a shift).
The content of composite keys is not retrieved but the item separator is present (to avoid a shift).

Component : wd240hf.dll