Keyoti RapidSpell Desktop .NET API Docs
FileName Property
APIKeyoti.RapidSpell.CompressionGZipStreamFileName
Keyoti RapidSpell Desktop .NET
The FileName for the GZIP stream.
Declaration Syntax
C#C#Visual BasicVisual BasicVisual C++Visual C++F#F#
public string FileName { get; set; }
public string FileName { get; set; }
Public Property FileName As String
	Get
	Set
Public Property FileName As String
	Get
	Set
public:
property String^ FileName {
	String^ get ();
	void set (String^ value);
}
public:
property String^ FileName {
	String^ get ();
	void set (String^ value);
}
member FileName : string with get, set
member FileName : string with get, set
Property Value
Remarks

The GZIP format optionally allows each file to have an associated filename. When compressing data (through Write()), set this FileName before calling Write() the first time on the GZipStream. The actual filename is encoded into the GZIP bytestream with the ISO-8859-1 code page, according to RFC 1952. It is the application's responsibility to insure that the FileName can be encoded and decoded correctly with this code page.

When decompressing (through Read()), you can retrieve this value any time after the first Read(). In the case where there was no filename encoded into the GZIP bytestream, the property will return null (Nothing in VB).

Assembly: Keyoti.RapidSpell.NET4 (Module: Keyoti.RapidSpell.NET4.dll) Version: 6.2.21.412