NAnt SDK Documentation - v0.85-nightly-2005-11-09

UnZipTask.ExtractFile Method 

[This is preliminary documentation and subject to change.]

Extracts a file entry from the specified stream.

[Visual Basic]
Protected Sub ExtractFile( _
   ByVal inputStream As Stream, _
   ByVal entryName As String, _
   ByVal entryDate As Date _
)
[C#]
protected void ExtractFile(
   Stream inputStream,
   string entryName,
   DateTime entryDate
);

Parameters

inputStream
The Stream containing the compressed entry.
entryName
The name of the entry including directory information.
entryDate
The date of the entry.

Remarks

We cannot rely on the fact that the directory entry of a given file is created before the file is extracted, so we should create the directory if it doesn't yet exist.

Exceptions

Exception Type Condition
BuildException

The destination directory for the entry could not be created.

-or-

The entry could not be extracted.

See Also

UnZipTask Class | NAnt.Compression.Tasks Namespace