HDescribeItem (Function)

How to describe an item by programming?
List of HFSQL properties that can be used to describe an item by programming
Syntax 2: Describing a temporary item in Hyper File 5.5 format (backward 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 by 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 re-initialized. 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 by programming Hide the details

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

<Result>: Boolean

True if the operation was performed,
False if a problem occurred. 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 Item description variable corresponding to the item to create.

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

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

<Result>: Boolean

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

<Logical name of 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 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 array of items.

Remarks

How to describe an item by programming?

To describe an item by programming, you must:

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

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

The following properties are available in read/write.


AccentuationSensitive	The Property SensitiveAccentuation allows you to set the accentuation to be taken into account in the various searches carried out on the heading or on the full-text index (with the HLitSearch, HLitSearchFirst and HLitSearchLast functions for example).
CaseSensitive	The Property Case Sensitive allows you to set the case sensitivity (upper/lower case) of the different searches performed on the topic or on the full-text index (with the functions HLitSearch, HLitSearchFirst and HLitSearchLast, for example).
Component	..Component is used to configure the different components of a composite key.
DefaultValue	The Property Default Value allows you to: Find out the default value of an item. This item was defined in the data model editor or by programming. Define the default value of an item (when describing the item by programming).
KeyExpression	The Property FormulaKey allows you to set the different components of a compound key.
KeyType	The Property TypeKey allows to set the characteristics of a key Item.
Name	The Property Name allows you to know: 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.
NbArrayElement	NbArrayElement is used to configure the number of elements in an array item.
PunctuationSensitive	The Property SensitivePunctuation allows you to set the parameters for taking punctuation (comma, full stop, etc.) into account in the various searches performed on the topic (with the HLitSearch, HLitSearchFirst and HLitSearchLast functions for example).
Size	The Size property is used to determine and change the size of an element.
SortType	The Property TypeTri allows 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 by programming. Define the sort direction for an item or for a component of a composite key (when describing the item by programming).
Type	The Property Type allows to know: the type of element described by 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.

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).

Component: wd260hf.dll