[opengtoolkit-cvs] lvzip/source readme.txt, NONE, 1.1 opengdoc.txt, 1.2, 1.3 readme2_2.txt, 1.3, NONE readme2_3.txt, 1.2, NONE

[Rolf K. <lab...@us...>]

Update of /cvsroot/opengtoolkit/lvzip/source
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv26760/source

Modified Files:
	opengdoc.txt 
Added Files:
	readme.txt 
Removed Files:
	readme2_2.txt readme2_3.txt 
Log Message:
Changed documentation

--- readme2_3.txt DELETED ---

--- readme2_2.txt DELETED ---

Index: opengdoc.txt
===================================================================
RCS file: /cvsroot/opengtoolkit/lvzip/source/opengdoc.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** opengdoc.txt	2 Jan 2006 11:21:13 -0000	1.2
--- opengdoc.txt	23 Sep 2006 05:02:22 -0000	1.3
***************
*** 24,28 ****
  Description
  
! The core of this libray is an external shared library consisting basically of the version 1.2.2 release of zlib and the version 1.0.1d of the zip library from Gilles Vollant.
  The current version supports most types of ZIP files with exception of the newest proprietary format created by the latest version of Winzip. It also supports
  adding files with password, and extracting password protected files.
--- 24,28 ----
  Description
  
! The core of this libray is an external shared library consisting basically of the version 1.2.3 release of zlib and the version 1.0.1e of the zip library from Gilles Vollant.
  The current version supports most types of ZIP files with exception of the newest proprietary format created by the latest version of Winzip. It also supports
  adding files with password, and extracting password protected files.
***************
*** 42,44 ****
  Copyright (C) 1995-2004 Mark Adler, Jean-loup Gailly
  Copyright (C) 1998-2004 Gilles Vollant
! Copyright (C) 2002-2005 Rolf Kalbermatter, Jim Kring, Christoph Salzmann
--- 42,44 ----
  Copyright (C) 1995-2004 Mark Adler, Jean-loup Gailly
  Copyright (C) 1998-2004 Gilles Vollant
! Copyright (C) 2002-2006 Rolf Kalbermatter, Jim Kring, Christoph Salzmann

--- NEW FILE: readme.txt ---
LabVIEW ZIP library, version 2.3
--------------------------------

Copyright 2002-2006 Rolf Kalbermatter


Please read this document before you upgrade from a version of LVZIP
older than 2.2 to this version.

The new version since 2.2 of LVZIP has some new features and some
modifications.

New features in 2.3:
--------------------
1) Transparent MacBinary support on the Macintosh

If the compression routine encounters a Macintosh file with a resource fork
the file is automatically encoded using the MacBinary algorithme before it
is actually compressed. On extraction of such files on the Macintosh the
file is restored with its resource fork. On non-Macintosh platforms extracting
a MacBinary file will result in the data fork being stored in the original
file and the resource fork being stored in the filename extended with the
.rsrc file ending.

2) LabVIEW 8 uncovered a problem when unextracting read-only files. The
application of the original creation and modification time to such files
failed now. This was fixed by always creating the extracted file with write
access and only change it to read-only after the original creation and
modification time has been applied.


New features in 2.2 (never really properly released):
-----------------------------------------------------

1) Password support (limited testing)

ZLIB Extract All Files To Dir.vi
ZLIB Compress Directory.vi
ZLIB Compress Files.vi
ZLIB Store File.vi
ZLIB Extract File.vi

A new string parameter was added to specify a password to use to extract
files or to encrypt files. This function is not thouroghly tested at this
time.


2) Adding of files into existing ZIP archive supported

ZLIB Compress Directory.vi
ZLIB Compress Files.vi
ZLIB Open Archive.vi

The boolean parameter to append or truncate has been replaced by an
enumeration to support addition of files into an existing archive.
The old append value meant that the ZIP file was tacked to the end
of the existing file which might have been useful for a selfextracting
executable only.

Following table shows the old and new settings

old value   new value          remarks

False       create new         truncates existing file to 0
True        append to end      appends to end of existing file
NA          append to archive  appends new files into the archive


3) Deleting of files from an existing ZIP archive.

ZLIB Delete Files From Archive.vi

This function will create a new archive and move all files except the
ones to remove into this new archive, replacing the old one with it if
the entire transfer was successful. The transfer between the old and
new archive happens in "raw mode" which means the data is transfered
compressed into the new file, speeding up the whole operation but even
more importantly eliminating the need to know the password for any of
the files in the archive for mere deleting of a file.
Of course the files in the new archive will be password protected just
as they have been in the old file.


Changes:
--------

1) To support the new append mode the "append" parameter for the
compression functions has been modified from a boolean to an
enumeration. This could cause bad wires when this function was
used in a program and this parameter was wired with a constant
or terminal. Since the non-default value was rarely useful, this
should not be a big problem for most users as it is unlikely this
parameter was ever wired.

2) To support specifying a password when compressing into an archive,
the connector pane of a few VIs had to be changed. You will need to
relink existing applications if you have used following four functions:

ZLIB Extract All Files To Dir.vi
ZLIB Compress Directory.vi
ZLIB Compress Files.vi
ZLIB Store File.vi

3) To simplify the interface of the file info structure the according
cluster was modified to be more in LabVIEW style. This caused the
change to the connector pane of two VIs, namely:

ZLIB Get Current File Info.vi
ZLIB Enumerate File Contents.vi

and the according strict typedef custom control

ZLIB File Info.ctl

The old VIs and custom control with the old connector pane are stored
under the same name but with the appendix "Old". This is a list of the
compatibility functions:

ZLIB Get Current File Info Old.vi
ZLIB Enumerate File Contents Old.vi
ZLIB File Info Old.ctl

If you have an older application where you directly used one of the
VIs described here from the old lvzip package you can either replace
those VIs by the compatibility VIs or rewire your application to work
with the new functions.

5) I was successful in making the "File Info.vi" function from the file
package work again. In doing so the "ZLIB Time Info.vi" function, which
really was a subset implementation of "File Info.vi" is now obsolete and
has been removed both from the VI library as well as the shared library.

If you should have happened to use this function you should use the
according File Info.vi from the file package instead and adapt your
cluster wiring.

Used libraries:
---------------

The lvzip package makes use of the error package, the file package and through
the last one also of the array package. Some functions in the file package have
been added in comparison to the latest released package and therefore this
version of lvzip will only work with the version 2.5 of the file package.

Have fun

Rolf Kalbermatter