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

From GAB Help
Jump to: navigation, search
m
 
Line 1: Line 1:
This function may be used before Compress, to specify the files to be compressed. Invoking this method populates the file collection accordingly.
+
==IncludeFiles(FileNames)==
 +
Specifies that the indicated files should be added to the archive.
  
==Syntax==
+
===Arguments===
Function.Automation.ZIPPro.IncludeFiles(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.IncludeFiles("FileNames")</code>
String
 
 
 
* Multiple FileNames should be delimited by " | "
 
 
 
==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.IncludeFiles(C:\users\abc\Desktop\Test.pdf)
 
Function.Automation.ZIPPro.IncludeFiles(C:\users\abc\Desktop\TEST_ZIP\)
 
Function.Automation.ZIPPro.SetProperty("ARCHIVEFILE",0,C:\users\abc\Documents\createzip.zip)
 
'Create the .Zip file
 
function.automation.ZIPPro.Compress()
 
</nowiki>
 
 
 
==Remarks==
 
* Invoking IncludeFiles will not reset the control, or remove old values of FileCompressedName and FileDecompressedName. This may be done by first clearing the File collection.
 
* If wildcards are specified, the file system will be scanned and all files matching the specified mask will be added.
 
* Subdirectories will be recursed only if RecurseSubdirectories is set to true.
 
  
  
 
[[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:42, 20 May 2020

IncludeFiles(FileNames)

Specifies that the indicated files should be added to 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.IncludeFiles("FileNames")