Difference between revisions of "Function.Automation.ZIPPro.Extract"

From GAB Help
Jump to: navigation, search
m
 
Line 1: Line 1:
This function extracts one or more files from the archive. The file(s) will be extracted to the directory specified by ExtractToPath.
+
==Extract(FileNames)==
 +
Extracts a single file, directory, or group of files, from the archive.
  
==Syntax==
+
===Arguments===
Function.Automation.ZIPPro.Extract(filenames [String])
+
====FileNames as String====
 +
File paths may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be affected; A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly.
  
==Arguments==
+
===Examples===
===filenames===
+
<code>Function.Automation.ZIPPro.Extract("FileNames")</code>
String
 
 
 
* Multiple Filenames should be delimited by " | "
 
 
 
* " * " should be used to extract all the files
 
 
 
==Examples==
 
<nowiki>Function.Automation.ZIPPro.Reset()
 
Function.Automation.ZIPPro.INCLUDEFILES(C:\users\abc\Documents\CreateZip\|C:\Users\abc\Documents\Test_ZIPPro.Docx)
 
Function.Automation.ZIPPro.SetProperty("ARCHIVEFILE",0,C:\users\abc\Documents\createzip.zip)
 
'Create the .Zip file
 
function.automation.ZIPPro.Compress()
 
'Excludes the files in the .zip file
 
Function.Automation.ZIPPro.SetProperty("EXCLUEDEDFILES",1," *.sql | *.txt ")
 
Function.Automation.ZIPPro.SetProperty("OVERWRITEFILES",1,"False")
 
'Extract Method
 
'Provide the path of the exisitng folder where the .zip file will be extracted
 
Function.Automation.ZIPPro.SetProperty("EXTRACTTOPATH",0,C:\users\abc\Documents\ExtractedFiles)
 
'Extracts only Non ExcludedFiles
 
function.automation.ZIPPro.EXTRACT("*")</nowiki>
 
 
 
==Remarks==
 
* Files may be specified with or without a path, and with or without wildcards.
 
* If a path is specified, files in the indicated directory will be affected; subdirectories will be recursed into if RecurseSubdirectories is true. If no path is specified but wildcards are, matching files in all directories will be affected.
 
* If a single filename without a path is specified, it must correspond exactly to the appropriate value of FileCompressedName.
 
  
  
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:Function.Automation]]
 
[[Category:Function.Automation.ZIPPro]]
 
[[Category:Function.Automation.ZIPPro]]
[[Category:NeedsExample]]
+
 
[[Category:NeedsEdit]]
+
__FORCETOC__
[[Category:Function.Automation]]
 

Latest revision as of 13:39, 20 May 2020

Extract(FileNames)

Extracts a single file, directory, or group of files, from the archive.

Arguments

FileNames as String

File paths may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be affected; A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly.

Examples

Function.Automation.ZIPPro.Extract("FileNames")