IdeaBlade DevForce 2010 Help Reference
Comment Property
See Also  Send Feedback
IdeaBlade.Core Assembly > Ionic.Zlib Namespace > GZipStream Class : Comment Property



The comment on the GZIP stream.

Syntax

Visual Basic (Declaration) 
Public Property Comment As String
Visual Basic (Usage)Copy Code
Dim instance As GZipStream
Dim value As String
 
instance.Comment = value
 
value = instance.Comment
C# 
public string Comment {get; set;}
C++/CLI 
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).

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2013 All Rights Reserved.