Skip to main content

WixOutput Class

Class that understands the standard file structure of the WiX toolset.

Methods

MethodDescription
Create()Creates a new file structure in memory.
Create(path)Creates a new file structure on disk.
Create(uri, stream)Creates a new file structure.
CreateDataStream()Creates a data stream in the wixout.
Dispose()Disposes of the internal state of the file structure.
Dispose(disposing)Disposes of the internsl state of the file structure.
ExtractEmbeddedFile(embeddedId, outputPath)Extracts an embedded file.
GetData()Gets the data of the file as a string.
GetDataStream()Gets a non-closing stream to the data of the file.
ImportDataStream(name, path)Imports a file from disk into the output.
Read(path)Loads a wixout from a path on disk.
Read(baseUri)Loads a wixout from a path on disk or embedded resource in assembly.
Read(assembly, resourceName)Loads a wixout from an assembly resource stream.
Read(uri, stream)Reads a file structure from an open stream.
Reopen(writable)Reopen the underlying archive for read-only or read-write access.

Properties

PropertyDescription
Uri

WixToolset.Data.dll version 5.0.0+41e11442b2ca93e444b60213b5ae99dcbab787d8

Create() Method

Creates a new file structure in memory.

Declaration

public static WixOutput Create()

Return value

WixOutput Newly created WixOutput .

Create(path) Method

Creates a new file structure on disk.

Declaration

public static WixOutput Create(
string path
)

Parameters

ParameterTypeDescription
pathstringPath to write file structure to.

Return value

WixOutput Newly created WixOutput .

Create(uri, stream) Method

Creates a new file structure.

Declaration

public static WixOutput Create(
System.Uri uri,
System.IO.Stream stream
)

Parameters

ParameterTypeDescription
uriSystem.Uri
streamSystem.IO.StreamStream to write the file structure to.

Return value

WixOutput Newly created WixOutput .

CreateDataStream() Method

Creates a data stream in the wixout.

Declaration

public System.IO.Stream CreateDataStream()

Return value

System.IO.Stream Stream to the data of the file.

Dispose() Method

Disposes of the internal state of the file structure.

Declaration

public void Dispose()

Dispose(disposing) Method

Disposes of the internsl state of the file structure.

Declaration

protected void Dispose(
bool disposing
)

Parameters

ParameterTypeDescription
disposingboolTrue if disposing.

ExtractEmbeddedFile(embeddedId, outputPath) Method

Extracts an embedded file.

Declaration

public void ExtractEmbeddedFile(
string embeddedId,
string outputPath
)

Parameters

ParameterTypeDescription
embeddedIdstringId to the file to extract.
outputPathstringPath to write the extracted file to.

GetData() Method

Gets the data of the file as a string.

Declaration

public string GetData()

Return value

string String contents data of the file.

GetDataStream() Method

Gets a non-closing stream to the data of the file.

Declaration

public System.IO.Stream GetDataStream()

Return value

System.IO.Stream Stream to the data of the file.

ImportDataStream(name, path) Method

Imports a file from disk into the output.

Declaration

public void ImportDataStream(
string name,
string path
)

Parameters

ParameterTypeDescription
namestringName of the stream in the output.
pathstringPath to file on disk to include in the output.

Read(path) Method

Loads a wixout from a path on disk.

Declaration

public static WixOutput Read(
string path
)

Parameters

ParameterTypeDescription
pathstringPath to wixout file saved on disk.

Return value

WixOutput Loaded created WixOutput .

Read(baseUri) Method

Loads a wixout from a path on disk or embedded resource in assembly.

Declaration

public static WixOutput Read(
System.Uri baseUri
)

Parameters

ParameterTypeDescription
baseUriSystem.UriUri with local path to wixout file saved on disk or embedded resource in assembly.

Return value

WixOutput Loaded created WixOutput .

Read(assembly, resourceName) Method

Loads a wixout from an assembly resource stream.

Declaration

public static WixOutput Read(
System.Reflection.Assembly assembly,
string resourceName
)

Parameters

ParameterTypeDescription
assemblySystem.Reflection.Assembly
resourceNamestring

Return value

WixOutput Loaded created WixOutput .

Read(uri, stream) Method

Reads a file structure from an open stream.

Declaration

public static WixOutput Read(
System.Uri uri,
System.IO.Stream stream
)

Parameters

ParameterTypeDescription
uriSystem.Uri
streamSystem.IO.StreamStream to read from.

Return value

WixOutput Loaded created WixOutput .

Reopen(writable) Method

Reopen the underlying archive for read-only or read-write access.

Declaration

public void Reopen(
bool writable
)

Parameters

ParameterTypeDescription
writableboolIndicates whether the output can be modified. Defaults to false.

Uri Property

Declaration

public System.Uri Uri { get; set; }