Comment Property

DotNetZip

previous page next page

Ionic Zip Library v1.9.1.6 Comment Property

The comment on the GZIP stream.

Declaration Syntax

Visual Basic

Visual C++

public string Comment { get; set; }

Public Property Comment As String
	Get
	Set

public:
property String^ Comment {
	String^ get ();
	void set (String^ value);
}

Remarks

The GZIP format allows for each file to optionally have an associated comment stored with the file. The comment is encoded with the ISO-8859-1 code page. To include a comment in a GZIP stream you create, set this property before calling Write() for the first time on the GZipStream.

When using GZipStream to decompress, you can retrieve this property after the first call to Read(). If no comment has been set in the GZIP bytestream, the Comment property will return null (Nothing in VB).

Assembly: Ionic.Zip (Module: Ionic.Zip) Version: 1.9.1.8 (1.9.1.8)

previous page start next page