HBuildKeyValueANSI (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / Managing databases / HFSQL / HFSQL functions

When to use HBuildKeyValueANSI?

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HFSQL management functions

HBuildKeyValueANSI (Function)

In french: HConstruitValCléANSI

Available only with these kinds of connection

Regardless of the platform used, the data stored in the HFSQL files is in ANSI format.

On a UNICODE platform, HBuildKeyValueANSI builds the value of a composite key to store it in an HFSQL data file.

On an ANSI platform, this function is equivalent to HBuildKeyValue.

HBuildKeyValueANSI must not be used to:

implement a filter (HFilter) on a composite key.
perform a search (HReadSeekFirst, HReadSeekLast, etc.) on a composite key.

For the filters or searches, use HBuildKeyValue.

Reminder: The composite keys are binary strings whose content cannot be displayed directly. For more details, see Composite keys.

Example

// Assign an item in a linked data file
Invoice.CustLastNameFirstName = HBuildKeyValueANSI(Customer, ...
CustLastNameFirstName, Customer.LastName, Customer.FirstName)

Syntax

<Result> = HBuildKeyValueANSI(<Data file> , <Composite key> , <Value of components>)

<Result>: Character string

Value of the composite key to be stored in the data file.

<Data file>: Character string

Name of HFSQL data file used.

<Composite key>: Character string

Name of the item corresponding to the composite key.

<Value of components>: Character string

Value that will be assigned to each component of the composite key.
This parameter has the following format: <Component 1> , <Component 2>, ...,<Component N>.
For example: "MOORE", "Vince".

Remarks

When to use HBuildKeyValueANSI?

HBuildKeyValueANSI can be used to store the value of a composite key used as a link key in a data file.

Example:

To add a new invoice in a UNICODE platform, use the following code:

Invoice.InvoiceNum = ...
...
Invoice.CustLastNameFirstName = HBuildKeyValueANSI(Customer, ...
CustLastNameFirstName, Customer.LastName, Customer.FirstName)
...
HAdd(Invoice)

Business / UI classification: Business Logic

Component: wd280hf.dll