<Source>.ListItem (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Displaying the result in a List Box or Combo Box control

HFSQL type

See also

<Source>.ListItem (Function)

In french: <Source>.ListeRubrique

Not available with this kind of connection

Returns the list of items in a data file (query or view) recognized by the HFSQL engine. The data files defined by <Source>.Declare, <Source>.DeclareExternal and <Source>.DescribeFile are taken into account.

Example

// Retrieve items of a data file from current analysis
ItemList is string
ItemList = Customer.ListItem(hLstDetail)

// Add the list of items into COMBO_COMBO1
COMBO_COMBO1.Add(ItemList)

// Run a "SELECT *" query and interrogate the items
dsListCITY is Data Source
sListItm is string
sRecContent is string
sQry is string = "SELECT * FROM ZIPCODES WHERE ZIPCODE ='34000'"

// Run the query
dsListCITY.ExecuteSQLQuery(hQueryDefault, sQry)
// List the items of the query.
sListItm = dsListCITY.ListItem()

// Browse the query
FOR EACH dsListCITY
sRecContent = ""
// The items must be browsed for each record
FOR EACH STRING sAnItem OF sListItm SEPARATED BY CR
sRecContent += {"dsListCITY." + sAnItem, indItem}
END
Info("Content of the record: " + sRecContent)
END

Syntax

Listing the items of a data file Hide the details

<Result> = <Source>.ListItem([<Path of WDD> [, <Password of WDD> [, <Options>]]])

<Result>: Character string

List of items found in the specified data file. The descriptions of each item are separated by CR characters (Carriage Return). The result is more or less detailed depending on the constant used:
hLstDetail is not specified <Name of item 1> + CR + <Name of item 2> + CR + ...
hLstDetail is specified <Name of item 1> + TAB + <Type> + TAB + <HFSQL type> + TAB + <Size> + TAB + <Number of subscripts> + TAB + <Caption> + CR + ...
hLstDetailPlus <Name of item 1> + TAB + <Type> + TAB + <HFSQL type> + TAB + <Size> + TAB + <Number of subscripts> + TAB + <Caption> + TAB + <Integer part of numeric items> + TAB + <Decimal part of numeric items> + CR + ...
Where:
<Name of item X>: Item name
<Type>: Type of item: "T" for text (and currency) or "N" for numeric
<HFSQL type>: HFSQL type of item. See Remarks for more details.
<Size>: Item size
<Number of subscripts>: Number of elements in the array
<Caption>: Caption of item.
<Integer part of numeric items>: Number of digits in the integer part of numeric items
<Decimal part of numeric items>: Number of digits in the decimal part of numeric items
In Java, <Caption> corresponds to the name of item.

<Source>: Type corresponding to the specified source

Name of data file (query or view) whose items will be listed.
If a query name is specified, this query must be currently run (<Fichier HFSQL>.ExécuteRequête or <Fichier HFSQL>.ExécuteRequêteSQL) in order for <Source>.ListItem to operate. Otherwise, a WLanguage error occurs.

<Path of WDD>: Optional character string

Full path of analysis (.WDD file) where the data file is described. If this parameter is not specified or if it is equal to an empty string (""), the data file is sought in the current analysis.
This parameter is ignored. The data file is sought in the current analysis.

<Password of WDD>: : Optional character string

Password defined for the analysis. If no password is defined, this parameter must be equal to an empty string ("").
This parameter is ignored.

<Options>: Optional Integer constant (or combination of constants)

Type of list to perform:
hLstNormal
(default value) Corresponds to hLstItem + hLstMemo + hLstKey
hLstKey Lists the key items (non-composite keys only)
This constant is ignored.
hLstCompositeKey Lists the composite key items only
This constant is ignored.
hLstDetail Detailed information (idem earlier versions).
hLstDetailPlus For the numeric items, adds the number of digits in the integer part and in the decimal part.
This constant is ignored.
hLstMemo Lists the memo items
This constant is ignored.
hLstLogicalOrder Sorts the list in logical order of items (ignored if hLstSorted is specified)
This constant is ignored.
hLstItem Lists the non-key and non-memo items
hLstOriginalItem Used on a log file (xxxJNL.fic), lists the items of the source file (that was logged). For example, on CustomerLOG.Fic, lists the items of CUSTOMER file.
This constant is ignored.

This constant is not available.
hLstAll Lists all the type of items (hLstItem + hLstMemo + hLstKey + hLstCompositeKey)
This constant is ignored.
hLstSorted Sorts the list in alphabetical order
This constant is ignored.

Remarks

Order of items

The items listed in <Result> are sorted according to the physical order of items in the data file (except if the hLstSorted constant is used).

Displaying the result in a List Box or Combo Box control

<Result> can be directly assigned to a List Box or Combo Box control by <List Box>.Add. Each row will contain the description of an item.

HFSQL type

The possible HFSQL types are as follows:


0	unknown type	1	automatic identifier on 8 bytes
2	text item	3	signed integer item on 2 bytes
4	signed integer item on 1 byte	5	signed integer item on 4 bytes
6	simple real item (on 4 bytes)	7	simple real item (on 8 bytes)
8	record number item (unsigned integer)	9	unsigned integer item on 2 bytes
10	date item on 6	11	time item
12	unsigned integer item on 1 byte	13	turbo real item
14	date item on 8	15	text memo item
16	binary memo 4.0 item	17	currency item
18	binary memo, image memo item, Sound memo, OLE memo or other binary memo	19	signed integer item on 8 bytes
20	unsigned integer item on 8 bytes	21	image item
22	unsigned integer item on 4 bytes	23	character string item
24	date+time item	25	duration item
26	character item	27	boolean item
28	automatic identifier item (on 4 bytes)	29	Unicode text item
30	Unicode text memo item	31	high-precision numeric item
32	Versions 20 and later Enumeration item New in version 20 Enumeration item Enumeration item	33	Versions 20 and later Combination item New in version 20 Combination item Combination item
34	Versions 24 and later 128-bit UUID item New in version 24 128-bit UUID item 128-bit UUID item	35	Versions 24 and later 128-bit automatic UUID item New in version 24 128-bit automatic UUID item 128-bit automatic UUID item
36	Versions 24 and later 256-bit UUID item New in version 24 256-bit UUID item 256-bit UUID item	37	Versions 24 and later 256-bit automatic UUID item New in version 24 256-bit automatic UUID item 256-bit automatic UUID item

Component : wd260hf.dll