fExtractResource (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

External file management functions

Special case: Extracting a database

Special case: ".WDD" file (analysis description)

See also

fExtractResource (Function)

In french: fExtraitRessource

Extracts a resource from the application into a physical device location.

Remarks:

The resource to extract must have been included in the generated application by the generation wizard (see Notes).
Versions 23 and later
In WINDEV applications or WEBDEV sites, the resource to extract must be:
- in the "Other" category of the Project explorer pane,
- in the main library of the application (WDL file).
New in version 23
In WINDEV applications or WEBDEV sites, the resource to extract must be:
- in the "Other" category of the Project explorer pane,
- in the main library of the application (WDL file).
In WINDEV applications or WEBDEV sites, the resource to extract must be:
- in the "Other" category of the Project explorer pane,
- in the main library of the application (WDL file).
This function can be used in the Android simulator.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android widget mode.

New in version 18

This function is now available in Android widget mode.

Versions 21 and later

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

New in version 21

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

Versions 23 and later

This function is now available for Windows and Linux applications.

This function is now available for Windows and Linux sites.

New in version 23

This function is now available for Windows and Linux applications.

This function is now available for Windows and Linux sites.

This function is now available for Windows and Linux applications.

This function is now available for Windows and Linux sites.

Example

// Reads the content of readme.txt text file included in the application resources
IF fExtractResource("readme.txt", "/sdcard/extraction.txt") = True THEN
EDT_Text = fLoadText("/sdcard/extraction.txt")
END

// Used to precisely locate the HFSQL data on the Android Smartphone
sDataPath is string = SysRepDirStorageCard() + fSep() + "Customer tests" + fSep()
IF NOT fDirectoryExist(sDataPath) THEN fMakeDir(sDataPath)

fExtractResource("Product.fic", sDataPath + "Product.fic")
fExtractResource("Product.ndx", sDataPath + "Product.ndx")
fExtractResource("Product.mmo", sDataPath + "Product.mmo")

IF NOT HChangeDir(Product, sDataPath) THEN
Error(HErrorInfo())
END

Versions 19 and later

// Extracts all the images in PNG format
fExtractResource("*.png", CompleteDir(SysDirStorageCard()) + "images")

New in version 19

// Extracts all the images in PNG format
fExtractResource("*.png", CompleteDir(SysDirStorageCard()) + "images")

Syntax

<Result> = fExtractResource(<Resource name> [, <Destination>])

<Result>: Boolean

True if the resource was extracted,
False otherwise. If an error occurs, the ErrorOccurred variable is set to True. To get more details on the error, use ErrorInfo.

<Resource name>: Character string

Name of resource to extract (file name with its extension).
Versions 19 and later
The wildcard characters (* and?) are allowed. This allows you to extract several resources in a single call. In this case, the <Destination> parameter must correspond to a directory (that exists or not).
New in version 19
The wildcard characters (* and?) are allowed. This allows you to extract several resources in a single call. In this case, the <Destination> parameter must correspond to a directory (that exists or not).
The wildcard characters (* and?) are allowed. This allows you to extract several resources in a single call. In this case, the <Destination> parameter must correspond to a directory (that exists or not).
Versions 23 and later
The resource to extract must be found in the main application library (WDL file). The library must have not been loaded by LoadWDL.
New in version 23
The resource to extract must be found in the main application library (WDL file). The library must have not been loaded by LoadWDL.
The resource to extract must be found in the main application library (WDL file). The library must have not been loaded by LoadWDL.

<Destination>: Optional character string

Full or relative path of destination file. This path can be relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
If the directory exists, the resource is directly extracted into this directory.
The directory is created if it does not exist.
If this parameter is not specified or if it corresponds to an empty string (""), the resource will be extracted into the current application directory in a file named like the resource.
The destination file will be overwritten if it already exists before the extraction.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application can only write to its setup directory or one of its subdirectories, as well as to the external memory (SDCard).
Full path of destination file. This parameter is case-sensitive.
If the directory exists, the resource is directly extracted into this directory.
The directory is created if it does not exist.
If this parameter is not specified or if it corresponds to an empty string (""), the resource will be extracted into the "Documents" application directory in a file named like the resource.
The destination file will be overwritten if it already exists before the extraction.
Versions 23 and later
Full path of destination file.
If the directory exists, the resource is directly extracted into this directory.
The directory is created if it does not exist.
If this parameter is not specified or if it corresponds to an empty string (""), the resource will be extracted into the application data directory (returned by fDataDir) in a file named like the resource.
The destination file will be overwritten if it already exists before the extraction.
New in version 23
Full path of destination file.
If the directory exists, the resource is directly extracted into this directory.
The directory is created if it does not exist.
If this parameter is not specified or if it corresponds to an empty string (""), the resource will be extracted into the application data directory (returned by fDataDir) in a file named like the resource.
The destination file will be overwritten if it already exists before the extraction.
Full path of destination file.
If the directory exists, the resource is directly extracted into this directory.
The directory is created if it does not exist.
If this parameter is not specified or if it corresponds to an empty string (""), the resource will be extracted into the application data directory (returned by fDataDir) in a file named like the resource.
The destination file will be overwritten if it already exists before the extraction.

Remarks

Generation wizard

The wizard for generating Android, Universal Windows 10 app or iPhone/iPad applications allows you to specify whether files and libraries must be included in the application.

In an Android application, you have the ability to include:

specific resources.
specific Java archives.

Then, these files can be:

used directly (files to read for example: sound files, image files, etc.).
extracted with fExtractResource (e.g., files that will be modified by the application)

If an image is included in the application, it can be directly assigned to a control by specifying its name. For example:

IMG_Image = image1

Versions 19 and later

You have the ability to list the files included in the application with fListResource.

New in version 19

You have the ability to list the files included in the application with fListResource.

For more details, see:

Android generation wizard.
Universal Windows 10 App generation wizard.
Versions 17 and later
iPhone/iPad generation wizard.
New in version 17
iPhone/iPad generation wizard.
iPhone/iPad generation wizard.

Special case: Extracting a database

If the file to extract is an SQLite database, use fDataDir to extract it into the data directory of the application ("databases" directory).

Example:

fExtractResource(<Database vame>.db, CompleteDir(fDataDir()) + <Database name>.db)

To connect to this database, all you have to do is specify <Database name>.db as source for the SQLite connection. For more details, see Android application: Using a database.

Special case: ".WDD" file (analysis description)

An analysis description (".WDD" file) integrated to the library of an application cannot be extracted.

To extract a file from a library that cannot be extracted by fExtractResource, you can use an HFSQL data file integrated in the library.

Component: wd270vm.dll