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

From GAB Help
Jump to: navigation, search
m
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
This command is used to read the properties of the files in the collection.
+
==ReadProperty(Name, Value)==
 +
Gets a property value.  The available properties can be found http://cdn.nsoftware.com/help/IZF/cs/Zip.htm
  
==Syntax==
+
===Arguments===
Function.Automation.ZIPPro.ReadProperty(Property [String], File Index [Long], Return)
+
====Name as String====
 +
The property name
 +
====Value as Any====
 +
The property value [as object]
  
==Arguments==
+
===Examples===
 +
<code>Function.Automation.ZIPPro.ReadProperty("Name",V.Local.Property)</code>
  
===Property===
+
====Indexed properties====
String
 
  
The properties are as follows (* marked properties require a file index):
+
The properties require a file index:
* ArchiveFile
+
* FileAttributes
* CompressionLevel
+
* FileComment
* EncrytpionAlgorithm
+
* FileCompressedDate
* ExcludedFiles
+
* FileCompressedName
* FileAttributes *
 
* FileComment *
 
* FileCompressedDate *
 
* FileCompressedName *
 
* FileCount
 
* FileDecompressedName
 
* ZipComment
 
  
===File Index===
+
<code>
Long
+
Function.Automation.ZIPPro.ReadProperty("FILECOUNT", V.Local.FileCountProperty)
Index of the file in the collection
 
  
===Return===
+
Function.Automation.ZIPPro.ReadProperty("FILECOMPRESSEDNAME", 1, V.Local.Property)
  
 +
Function.Automation.ZIPPro.ReadProperty("FILECOMPRESSEDNAME", 2, V.Local.Property)
 +
</code>
  
==Examples==
 
<nowiki>V.local.iFileCount.Declare(Long)
 
Function.Automation.ZIPPro.SetProperty("ARCHIVEFILE",0,"C:\users\abc\Desktop\TestZip.zip")
 
Function.Automation.ZIPPro.Scan()
 
Function.Automation.ZIPPro.ReadProperty("FileCount",0,V.local.iFileCount)</nowiki>
 
  
==Remarks==
 
* The properties ArchiveFile, CompressionLevel, EncrytpionAlgorithm, ExcludedFiles, FileCount, ZipComment does not take file index into consideration.
 
* [[Function.Automation.ZIPPro.Scan]] is used to populate the files from the archive into the collection.
 
  
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:Function.Automation]]
 
[[Category:Function.Automation.ZIPPro]]
 
[[Category:Function.Automation.ZIPPro]]
[[Category:NeedsEdit]]
+
 
[[Category:Function.Automation]]
+
__FORCETOC__

Latest revision as of 07:36, 21 May 2020

ReadProperty(Name, Value)

Gets a property value. The available properties can be found http://cdn.nsoftware.com/help/IZF/cs/Zip.htm

Arguments

Name as String

The property name

Value as Any

The property value [as object]

Examples

Function.Automation.ZIPPro.ReadProperty("Name",V.Local.Property)

Indexed properties

The properties require a file index:

  • FileAttributes
  • FileComment
  • FileCompressedDate
  • FileCompressedName

Function.Automation.ZIPPro.ReadProperty("FILECOUNT", V.Local.FileCountProperty)

Function.Automation.ZIPPro.ReadProperty("FILECOMPRESSEDNAME", 1, V.Local.Property)

Function.Automation.ZIPPro.ReadProperty("FILECOMPRESSEDNAME", 2, V.Local.Property)