Click or drag to resize

ZIP Class

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:dss_sharp.ZIP"]

Inheritance Hierarchy

Namespace:  dss_sharp
Assembly:  dss_sharp (in dss_sharp.dll) Version: 1.0.0
Syntax
public class ZIP : ContextState

The ZIP type exposes the following members.

Constructors
  NameDescription
Public methodZIP
Initializes a new instance of the ZIP class
Top
Methods
  NameDescription
Protected methodCheckForError (Inherited from ContextState.)
Public methodClose
Closes the current open ZIP file (API Extension)
Public methodContains
Check if the given path name is present in the current ZIP file. (API Extension)
Public methodEquals (Inherited from Object.)
Public methodExtract
Extracts the contents of the file "FileName" from the current (open) ZIP file. Returns a byte-string. (API Extension)
Protected methodFinalize (Inherited from Object.)
Public methodGetContextHandle
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodList
List of strings consisting of all names match the regular expression provided in regexp. If no expression is provided, all names in the current open ZIP are returned. See https://regex.sorokin.engineer/en/latest/regular_expressions.html for information on the expression syntax and options. (API Extension)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodOpen
Opens and prepares a ZIP file to be used by the DSS text parser. Currently, the ZIP format support is limited by what is provided in the Free Pascal distribution. Besides that, the full filenames inside the ZIP must be shorter than 256 characters. The limitations should be removed in a future revision. (API Extension)
Public methodRedirect
Runs a "Redirect" command inside the current (open) ZIP file. In the current implementation, all files required by the script must be present inside the ZIP, using relative paths. The only exceptions are memory-mapped files. (API Extension)
Public methodToString (Inherited from Object.)
Top
Fields
  NameDescription
Protected fieldapiutil (Inherited from ContextState.)
Protected fieldctx (Inherited from ContextState.)
Top
See Also