HDBDescribeField (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Using space characters in the parameters
Describing an item
Limitations

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HDBDescribeField (Function)

In french: HDBDécritRubrique

Available only with these kinds of connection

Describes through programming each item found in the structure of an xBase file described by HDBDescribeFile.

Remark: the files described by programming are files in dBase3 format.

Example

HDBDescribeFile("CUSTOMER", "DA", "C:\FILE\CUSTOMER.DBF")
HDBDescribeField("LASTNAME,C,20")
HDBDescribeField("FIRSTNAME,C,20")
HDBDescribeField("MARRIED,L")
HDBDescribeField("DOB,D")
HDBDescribeField("INFO,M")
HDBDescribeIndex("C:\FILE\LASTNFILE.NDX", "LASTNAME")
HDBDescribeIndex("C:\FILE\LNFNFILE.NDX", "FULLNAME,C,40", "LASTNAME+FIRSTNAME")
HDBCreation()

Syntax

<Result> = HDBDescribeField(<Name and type of item>)

<Result>: Boolean

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

<Name and type of item>: Character string

Name given to the item and type of item. This parameter has the following format:

<Item name>, <Item type>

where:
<Item name>: Name that will be used to handle this item by programming.
<Item type>: Type of item to create:
C,<Size> Text item, <Size> is the size of character string
N,<Size>,<NbDecimals> Numeric item. <Size> is the size of numeric value, <NbDecimals> is the number of decimals in the numeric value.
M Boolean item
D Date item (in "YYMMDD" format)
M Text Memo item

Remarks

Using space characters in the parameters

The parameters must not be separated by space characters; for example, you must not write:

HDBDescribeField("FIRSTNAME, C, 20")

You must write:

HDBDescribeField("FIRSTNAME,C,20")

Describing an item

An error 1009 will be generated if the file is already opened during the call to HDBDescribeField.
The keys (or indexes) are defined by HDBDescribeIndex.
The number of items created in a file by HDBDescribeField cannot exceed 128.
The maximum size of an item:
- cannot exceed 254 characters for a non-key text item.
- cannot exceed 100 characters for a key text item.
- cannot exceed 19 digits in the integer part and 15 digits in the decimal part for a numeric item.
To use HDBDescribeField, the file was described by HDBDescribeFile.

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