HExportJSON (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Exporting the query content

Exporting a single record

HCreateMoveableReplica

HCreateSubscriberReplica

HDeactivateAutoFilter

HDescribeFullTextIndex

HErrorStatusModification

HExecuteQuery

HExecuteQueryAsynchronous

HExecuteSQLQuery

HExecuteSQLQueryAsynchronous

HFilterIncludedBetween

HMigrateLinkedCompositeKey

HRecreateSubscriberReplica

Exporting the query content
Exporting a single record
Array items

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HExportJSON (Function)

In french: HExporteJSON

Not available with these kinds of connection

Exports the records found in a data file (HFSQL or OLE DB), view or query to a JSON file.

Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Versions 22 and later

This function is now available for iPhone/iPad applications.

This function is now available in Universal Windows 10 App mode.

New in version 22

This function is now available for iPhone/iPad applications.

This function is now available in Universal Windows 10 App mode.

This function is now available for iPhone/iPad applications.

This function is now available in Universal Windows 10 App mode.

Example

// Export all customers
HExportJSON(CUSTOMER, "C:\TEMP\Customer.json", hExpCreation)

Syntax

<Result> = HExportJSON(<Data file> [, <JSON file> [, <Items to export>]] [, <Options> [, <Progress Bar>]])

<Result>: Boolean

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

<Data file>: Character string (with or without quotes)

Name of data file, view or query used. If this name is not specified, HExportJSON will use the last data file used by the last HFSQL management function (function starting with "H").

<JSON file>: Optional character string

Full path of JSON file to generate.

<Items to export>: Optional character string

List of names of items to export. The names are delimited by single quotes and they are separated by commas or CR characters. The names of composite key items, binary items and binary memo items are ignored.
If this parameter corresponds to an empty string (""), all the items of the data file (except for the composite keys, binary keys and binary memo keys) are exported.

<Options>: Optional constant

Specifies the creation mode of JSON file:
hExpCreation If the JSON file already exists, it is overwritten. An error occurs if this option is not specified and if the JSON file exists.
hExpBreakable The export can be interrupted by pressing Esc.
If the export is interrupted, the JSON file is valid and it only contains the records exported before the interruption.
hExpNormal
(default value) Standard operating mode.

<Progress Bar>: Optional control name or window name

Name of Progress Bar control or name of window used to show the progress of file creation.

Remarks

Exporting the query content

To export the query content, you must initialize the query (HExecuteQuery) before using HExportJSON.

Exporting a single record

To export a single record to a JSON string, use HRecordToJSON.

Array items

If one of the exported items is an array item, each element of the array item is exported in a new level:

{"File":
{
"Item1":Data of item 1,
"Item2":Data of item 2,
"ArrItem":
[Data element 1, Data element 2, ...]
...
}
}

Reminder: Composite key, binary memo or binary items are ignored.

Business / UI classification : Business Logic

Component : wd260hf.dll