HListSpatialKeys (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / Managing databases / HFSQL / HFSQL functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HListSpatialKeys (Function)

In french: HListeClésSpatiales

Returns the spatial keys of a data file (used in a query or view) recognized by the HFSQL engine.

Example

// Récupérer les clés spatiales d'un fichier de données présent dans l'analyse en cours
ListeClésSpatiales is string
ListeCléSpatiales = HListSpatialKeys(Communes)
// Ajoute la liste des clés spatiales dans COMBO_Combo1
ListAdd(COMBO_Combo1, ListeClésSpatiales)

Syntax

<Result> = HListSpatialKeys(<Data file> [, <Path of the WDD file> [, <Password of the WDD file>]])

<Result>: Character string

List of spatial keys in the specified data file. Names of spatial items are separated by carriage returns (CR).

<Data file>: Character string

Name of the data file, query or view with spatial keys to be listed.
If a query name is specified, the query must be running (HExecuteQuery or HExecuteSQLQuery) to use HListSpatialKeys. Otherwise, a WLanguage error occurs.

<Path of the WDD file>: Optional character string

Full path of the analysis (i.e. the .WDD file) in which the data file has been defined.
If this parameter is not specified or is an empty string (""), the data file is searched for in the current analysis.

<Password of the WDD file>: Optional string or Secret string

Password defined for the analysis.
If no password is defined, this parameter must be an empty string ("").
New in version 2025
Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "ANSI or Unicode string".
To learn more about secret strings and how to use the vault, see Secret string vault.

Business / UI classification: Business Logic

Component: wd300hf.dll