fExtractResource (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

External file management functions

Special case: Extraction from a database

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

See also

Constants for the external files

Functions for handling directories and external files

Handling the external files

Storing files in Android

Summary table: Managing the application directories according to the platform

fCurrentDir (Example)

fCurrentDir

fCurrentDrive (Example)

fDetectRemovableStorage

fDriveReady (Example)

fExtractPath (Example)

fGraphicFilter (Example)

fGraphicFilter

fImageSelect (Example)

fImageSelect

fInsertTextAtBeginning

fIsImage

fListDirectory (Example)

fReadLineRegularExpression

fReportsAndQueriesDir

fSizeUncompressed (Example)

fSizeUncompressed

fSplit

fStopCompress (Example)

fUncompress (Example)

Generation wizard
Special case: Extraction from a database
Special case: ".WDD" file (analysis description)

WINDEV

WEBDEV

WINDEV Mobile

Others

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).
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.

Caution: To prevent piracy, WINDEV, WEBDEV and WINDEV Mobile elements (reports, windows, etc.) cannot be extracted at runtime.

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

// 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).
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 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.
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 that will only be 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

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

For more details, see:

Special case: Extraction from 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: wd280vm.dll