HDescribeItem (Function)

How to describe an item through programming?
List of HFSQL properties that can be used to describe an item through programming
Syntax 2: Describing a temporary item in Hyper File 5.5 format (backward compatibility)
Compatibility

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HDescribeItem (Function)

In french: HDécritRubrique

Not available with this kind of connection

Describes a file item through programming.

After the call to HDescribeItem:

The item can be handled like any other item described in the analysis.
The item description cannot be modified anymore.
The description variable of item is reinitialized. A new item description can be performed.

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 Windows Store apps mode.

New in version 18

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.

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

Example

See additional examples

HDescribeItem(CustomerBis, CustomerName)

Syntax

Describing an item of a data file created through programming Hide the details

<Result> = HDescribeItem(<Data file> , <Item>)

<Result>: Boolean

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

<Data file>: File Description variable

Name of the File description variable that corresponds to the data file in which the item must be created.

<Item>: Item Description variable

Name of the Item Description variable corresponding to the item to be created.

Describing a temporary item in Hyper 5.5 format (backward compatibility only) Hide the details

<Result> = HDescribeItem(<Logical name of the Hyper File 5.5 file> , <Item description> [, <Array dimension>])

<Result>: Boolean

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

<Logical name of the Hyper File 5.5 file>: Character string

Name of temporary data file in Hyper File 5.5 format described by HDescribeFile (Syntax 2).

<Item description>: Character string

Description of item in the following format: <Item name>,<Item type> (no space between <Item name> and <Item type>).
<Item name> contains the name of item
<Item type> contains the item type and it can take one of the following values:
E: for the Integer items
M: for the Long Integer items
C: for the Short Integer items
S: for the Simple Real items
D: for the Double Real items
A: for the Date items on 8 digits (YYYYMMDD)
H: for the Time items (HHMM)
T,<Size>: for the Text items (<Size> is the size of the character string)
M: for the Text Memo items
O: for the Binary Memo items
F: for the Currency items

<Array dimension>: Optional integer

Size of the array of items.

Remarks

How to describe an item through programming?

To describe an item through programming, you must:

Use the Link description, File Description and Item Description variables (if necessary).
Describe the characteristics of the data file, its items and links using HFSQL properties.
Define the description of the items with HDescribeItem.
Define the description of the data file (HDescribeFile) and the links (HDescribeLink).

List of HFSQL properties that can be used to describe an item through programming

The following properties are available in read/write mode.


Component	The Component property configures the different components of a composite key.
KeyExpression	The KeyExpression property is used to set the different components of a composite key.
NbArrayElement	NbArrayElement is used to configure the number of elements in an array item.
Name	The Name property is used to get: the name of the font associated with a Font variable. the name of a control, report or report block. the name of a control, group of controls or window. the name of a control, group of controls or page.
AccentSensitive	The AccentSensitive property is used to determine if accented characters are taken into account in the different searches performed on the item (with HReadSeek, HReadSeekFirst and HReadSeekLast, for example).
CaseSensitive	The CaseSensitive property is used to determine if the different searches performed on the item distinguish between uppercase and lowercase characters (with HReadSeek, HReadSeekFirst and HReadSeekLast, for example).
PunctuationSensitive	The PunctuationSensitive property is used to determine if punctuation characters (comma, period, etc.) are taken into account in the different searches performed on the item (with HReadSeek, HReadSeekFirst and HReadSeekLast, for example).
Size	The Size property is used to determine and change the size of an element.
Type	The Type property is used to get: the type of element described through programming (file or item description) or not (file or item defined in the data model editor, view or query). the type of object. the type of value stored in a variant.
KeyType	The KeyType property is used to set the characteristics of a key item.
SortType	The SortType property is used to: Find out the sort direction defined for an item or for a component of a composite key. This item was defined in the data model editor or through programming. Define the sort direction for an item or for a component of a composite key (when describing the item through programming).
DefaultValue	The DefaultValue property is used to: Find out the default value of an item. This item was defined in the data model editor or through programming. Define the default value of an item (when describing the item through programming).

Syntax 2: Describing a temporary item in Hyper File 5.5 format (backward compatibility)

This syntax is used to create temporary items in the temporary data files in Hyper File 5.5 format. This syntax can only be used in an application developed with WINDEV 5.5 or WEBDEV 1.5 then migrated to version 18. To use this function:

the analysis in WINDEV 5.5 format must be accessible on the development computer.
the path of the WINDEV 5.5 analysis must be specified in the characteristics of the analysis ("Details" tab).

Compatibility

This function replaces HDescribeKey, which is kept for compatibility with WINDEV 5.5.

Component: wd270hf.dll