ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / Managing databases / HFSQL / HFSQL functions
  • How to describe an item through programming?
  • List of HFSQL properties that can be used to describe an item through programming
  • Compatibility
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
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.
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.
Remarks

How to describe an item through programming?

To describe an item through programming, you must:
  1. Use the Link description, File Description and Item Description variables (if necessary).
  2. Describe the characteristics of the data file, its items and links using HFSQL properties.
  3. Define the description of the items with HDescribeItem.
  4. 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.
AccentSensitiveThe 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).
CaseSensitiveThe 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).
ComponentThe Component property configures the different components of a composite key.
DefaultValueThe 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).
KeyExpressionThe KeyExpression property is used to set the different components of a composite key.
KeyTypeThe KeyType property is used to set the characteristics of a key item.
NameThe 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.
NbArrayElementNbArrayElement is used to configure the number of elements in an array item.
PunctuationSensitiveThe 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).
SizeThe Size property is used to determine and change the size of an element.
SortTypeThe 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 programmatically.
  • Define the sort direction for an item or for a component of a composite key (when describing the item through programming).
TypeThe Type property is used to get:
  • the type of element (data file or item) defined programmatically or in the data model editor, view or query.
  • the type of object.
  • the type of data held in a Variant.

Compatibility

This function replaces HDescribeKey, which is kept for compatibility with WINDEV 5.5.
Component: wd290hf.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 01/26/2023

Send a report | Local help