- Search mode
- Index of files in the archive
- Formats of archives
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.
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: <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.
Business / UI classification: Business Logic
This page is also available for…
|
|
|
|