|
|
|
|
|
|
|
|
|
|
- How to describe an item through programming?
- List of HFSQL properties that can be used to describe an item programmatically
- Compatibility
HDescribeItem (Function) In french: HDécritRubrique
 Not available with this kind of connection
Describes a file item programmatically. 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(ClientBis, NomClient)
Syntax
Describing a data file item created programmatically 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>: Variable type Field description 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: - Use the File Description, Item Description and Link 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 programmatically The following properties are available in read/write mode.
| | | 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). | | Component | The Component property configures the different components of a composite key. | | 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 programmatically.
- Set the default value of an item (only for items defined programmatically).
| | KeyExpression | The KeyExpression property is used to set the different components of a composite key. | | KeyType | The KeyType property is used to set the characteristics of a key 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.
| | NbArrayElement | The NbArrayElement property is used to configure the number of elements in an array item. | | 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. | | 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 programmatically.
- Define the sort direction for an item or for a component of a composite key (when describing the item through programming).
| | Type | The 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.
This page is also available for…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|