HDBDescribeFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Using the EXTERN keyword
File description
Limitations

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HDBDescribeFile (Function)

In french: HDBDécritFichier

Available only with these kinds of connection

Describes a data file in dBase3 format (most common format) through programming. This function is used to specify the name, abbreviation and access path of xBase file.

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

Example

HDBDescribeFile("DBCUSTOMER", "CD", "C:\FILE\CUSTOMER.DBF")
HDBDescribeField("LASTNAME,C,20")
HDBDescribeField("FIRSTNAME,C,20")
HDBDescribeField("AGE,N,3,0")
HDBDescribeField("BALANCE,N,10,2")
HDBDescribeField("MARRIED,L")
HDBDescribeField("DOB,D")
HDBDescribeField("INFO,M")
HDBCreation()

Syntax

<Result> = HDBDescribeFile(<Logical name of xBase file> , <File prefix> , <Full name of physical file>)

<Result>: Boolean

True if the operation was performed,
False if a problem occurred. HError is used to identify the error.

<Logical name of xBase file>: Character string

Logical name of xBase file to create. This name will be used by all the functions that handle xBase files.

<File prefix>: Character string

File abbreviation (2 characters).

<Full name of physical file>: Character string

Path where the file will be created on disk and full file name (with the extension).

Remarks

Using the EXTERN keyword

We recommend that you use the EXTERN keyword to declare a file that will be described and created, in order to avoid warnings in the code editor. For example:

EXTERN Customer
HDBDescribeFile("CUSTOMER", "DA", "C:\FILE\CUSTOMER.DBF")

File description

An error 1009 will be generated if the file is already opened during the call to HDBDescribeFile.
The file will be created on disk by HDBCreation.
The file structure is described by HDBDescribeField. The number of items created in a file is limited to 128.
The indexes are described by HDBDescribeIndex.

Limitations

This function is not available when using a database via Remote Access.
This function is not available when using a stand-alone executable.

Component: wd270hf.dll