zipFindFile (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Archive management functions

Index of files in the archive

Formats of archives

See also

Archiving functions (management of ZIP, WDZ, CAB, RAR, 7z, TAR and TGZ (TAR.GZ))

Constants for the archiving functions

The archives

The single-part and multi-part archives

zipAddDirectory (Example)

zipChangePath (Example)

zipCreateExe (Example)

zipCreateExe

zipCurrentFile (Example)

zipCurrentFile

zipDeleteAll (Example)

zipDeleteAll

zipDeleteFile (Example)

zipDeleteFile

zipDeleteFileList

zipExist

zipExtractAll (Example)

zipExtractAll

zipExtractDirectory

zipExtractFile (Example)

zipExtractFile

zipExtractFileList

zipExtractPath (Example)

zipExtractPath

zipFileSize (Example)

zipFileSize

zipFilter

zipFindFile (Example)

zipFindFile

zipInfoFile (Example)

zipInfoFile

zipIsMulti (Example)

zipIsMulti

zipListFile (Example)

zipListFile

zipMerge (Example)

zipMerge

zipMsgError (Example)

zipNbPartNeeded (Example)

Search mode
Index of files in the archive
Formats of archives

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

zipFindFile (Function)

In french: zipChercheFichier

Finds a file in an archive (in CAB, ZIP, RAR, WDZ, 7z, TAR or TGZ (TAR.GZ) format). The search is performed in the stored path of the file.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

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.

This function now supports the 7z format.

New in version 18

This function is now available in Android widget mode.

This function now supports the 7z format.

This function is now available in Android widget mode.

This function now supports the 7z format.

Versions 21 and later

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

This function now supports the TAR and TGZ (TAR.GZ) formats.

New in version 21

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

This function now supports the TAR and TGZ (TAR.GZ) formats.

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

This function now supports the TAR and TGZ (TAR.GZ) formats.

Example

See additional examples

// Create the archive
ResCreate = zipCreate("MyArchive", "C:\Temp\Archive.zip")
IF ResCreate = 0 THEN
...
// Find a file whose stored path contains "Temp"
ResFileFound = zipFindFile("MyArchive", "Temp", False)
...
END

// Create the archive
MyArchive is zipArchive
ResCreate = zipCreate(MyArchive, "C:\Temp\Archive.zip")
IF ResCreate = 0 THEN
...
// Find a file whose stored path contains "Temp"
ResFileFound = zipFindFile(MyArchive, "Temp", False)
...
END

Syntax

<Result> = zipFindFile(<Archive> , <Sought path> [, <Search mode> [, <Start>]])

<Result>: Integer

Index of the file sought in the archive,
-1 if an error occurred.

<Archive>: Character string or zipArchive variable

Name of the archive in which the file must be sought.
This name can correspond to:
an archive name defined with zipOpen or zipCreate.
Versions 15 and later
the name of a variable of type zipArchive.
New in version 15
the name of a variable of type zipArchive.
the name of a variable of type zipArchive.
Versions 26 and later
zipArchive variables are now available.
New in version 26
zipArchive variables are now available.
zipArchive variables are now available.

<Sought path>: Character string

Full or partial path of the file to find. This parameter can correspond to:
a file name,
the full path of a file,
the path and name of a file,
...
When a path is specified, a backslash (\) is used as separator, and the root directory must not be specified.
The search is not case sensitive (lowercase/uppercase characters).

<Search mode>: Optional boolean

True (default value) for an exact-match search,
False for a generic search. The search is not case sensitive (lowercase/uppercase characters).
Archives in 7z format: This parameter is not available.

<Start>: Optional integer

Index of the file from which the search must be performed (1 by default, i.e. the first file included in the archive).
Archives in 7z format: This parameter is not available.

Remarks

Search mode

Depending on the selected <Search mode>, the result may differ:

If an exact-match search is performed, zipFindFile will find the files whose stored path is strictly identical to <Sought path>.
For example: an archive contains "Temp.doc", "Temp1.doc" and "Temp2.doc". An exact-match search for "Temp.doc" will find "Temp.doc".
If a generic search is performed, zipFindFile will find all the files whose stored path contains <Stored path>.
For example: an archive contains "Temp.doc", "Temp1.doc" and "Temp2.doc". A generic search for the "Temp" string will find three files.

Reminder: The stored path is defined with zipAddFile or zipAddDirectory.

Index of files in the archive

When a file is added into an archive, an index is automatically assigned to the file. This index corresponds to the order in which the files are included in the archive. To select a file in the archive, you can use:

the index of the element.
the stored path of element.

Formats of archives

Only ZIP, TAR and TGZ (TAR.GZ) archives are available.
Only ZIP archives are available.

Business / UI classification: Business Logic

Component: wd270zip.dll