Skip to main content

IBurnBackendBinderExtension Interface

Interface all Burn backend extensions implement.

Methods

MethodDescription
PostBackendBind(result)Called after output is bound into its final format.
PreBackendBind()Called before binding occurs.
ResolveRelatedFile(source, relatedSource, type, sourceLineNumbers)Called to find a file related to another source in the authoring. For example, most often used to find cabinets and uncompressed files for an MSI package.
ResolveUrl(url, fallbackUrl, packageId, payloadId, fileName)Called to customize the DownloadUrl provided in source cde.
SymbolsFinalized(section)Called right before the output is bound into its final format.
TryProcessSymbol(section, symbol)Called for each extension symbol that hasn't been handled yet. Use IBurnBackendHelper to add data.

WixToolset.Extensibility.dll version 4.0.2+644ed0118bae1aa885bb6cc906dc6c0b904de4d9

PostBackendBind(result) Method

Called after output is bound into its final format.

Declaration

public void PostBackendBind(
Data.IBindResult result
)

Parameters

ParameterTypeDescription
resultData.IBindResult

PreBackendBind() Method

Called before binding occurs.

Declaration

public void PreBackendBind()

ResolveRelatedFile(source, relatedSource, type, sourceLineNumbers) Method

Called to find a file related to another source in the authoring. For example, most often used to find cabinets and uncompressed files for an MSI package.

Declaration

public Data.IResolveFileResult ResolveRelatedFile(
string source,
string relatedSource,
string type,
WixToolset.Data.SourceLineNumber sourceLineNumbers
)

Parameters

ParameterTypeDescription
sourcestringPath to the source package.
relatedSourcestringExpected path to the related file.
typestringType of related file, such as "File" or "Cabinet"
sourceLineNumbersWixToolset.Data.SourceLineNumberSource line number of source package.

Return value

Data.IResolveFileResult IResolveFileResult if the related file was found, or null for default handling.

ResolveUrl(url, fallbackUrl, packageId, payloadId, fileName) Method

Called to customize the DownloadUrl provided in source cde.

Declaration

public string ResolveUrl(
string url,
string fallbackUrl,
string packageId,
string payloadId,
string fileName
)

Parameters

ParameterTypeDescription
urlstringThe value from the source code. May not actually be a URL.
fallbackUrlstringThe default URL if the extension does not return a value.
packageIdstringIdentifier of the package.
payloadIdstringIdentifier of the payload.
fileNamestringFilename of the payload.

Return value

string Url to override, or null to use default value.

SymbolsFinalized(section) Method

Called right before the output is bound into its final format.

Declaration

public void SymbolsFinalized(
WixToolset.Data.IntermediateSection section
)

Parameters

ParameterTypeDescription
sectionWixToolset.Data.IntermediateSectionThe finalized intermediate section.

TryProcessSymbol(section, symbol) Method

Called for each extension symbol that hasn't been handled yet. Use IBurnBackendHelper to add data.

Declaration

public bool TryProcessSymbol(
WixToolset.Data.IntermediateSection section,
WixToolset.Data.IntermediateSymbol symbol
)

Parameters

ParameterTypeDescription
sectionWixToolset.Data.IntermediateSectionThe linked section.
symbolWixToolset.Data.IntermediateSymbolThe current symbol.

Return value

bool True if the extension handled the symbol, false otherwise. The Burn backend will warn on all unhandled symbols.