Skip to main content

IBundleValidator Interface

Interface provided to help with bundle validation.

Methods

MethodDescription
GetCanonicalRelativePath(sourceLineNumbers, elementName, attributeName, relativePath)Validates path is relative and canonicalizes it. For example, "a..\c.\d.exe" ={'>'} "c\d.exe".
ValidateBundleCondition(sourceLineNumbers, elementName, attributeName, condition, phase)Validates a bundle condition and displays an error for an illegal value.
ValidateBundleMsiPropertyName(sourceLineNumbers, elementName, attributeName, propertyName)Validates an MsiProperty name value and displays an error for an illegal value.
ValidateBundleVariableNameDeclaration(sourceLineNumbers, elementName, attributeName, variableName)Validates a Bundle variable name that is being used to declare a Variable in the bundle manifest and displays an error for an illegal value.
ValidateBundleVariableNameTarget(sourceLineNumbers, elementName, attributeName, variableName)Validates a Bundle variable name that is being used to set its value and displays an error for an illegal value.
ValidateBundleVariableNameValue(sourceLineNumbers, elementName, attributeName, variableName, nameRule)Validates a Bundle variable name that is being used to reference a Variable and displays an error for an illegal value.

WixToolset.Extensibility.dll version 5.0.0+41e11442b2ca93e444b60213b5ae99dcbab787d8

GetCanonicalRelativePath(sourceLineNumbers, elementName, attributeName, relativePath) Method

Validates path is relative and canonicalizes it. For example, "a..\c.\d.exe" ={'>'} "c\d.exe".

Declaration

public string GetCanonicalRelativePath(
WixToolset.Data.SourceLineNumber sourceLineNumbers,
string elementName,
string attributeName,
string relativePath
)

Parameters

ParameterTypeDescription
sourceLineNumbersWixToolset.Data.SourceLineNumber
elementNamestring
attributeNamestring
relativePathstring

Return value

string The original value if not relative, otherwise the canonicalized relative path.

ValidateBundleCondition(sourceLineNumbers, elementName, attributeName, condition, phase) Method

Validates a bundle condition and displays an error for an illegal value.

Declaration

public bool ValidateBundleCondition(
WixToolset.Data.SourceLineNumber sourceLineNumbers,
string elementName,
string attributeName,
string condition,
WixToolset.Extensibility.Data.BundleConditionPhase phase
)

Parameters

ParameterTypeDescription
sourceLineNumbersWixToolset.Data.SourceLineNumber
elementNamestring
attributeNamestring
conditionstring
phaseWixToolset.Extensibility.Data.BundleConditionPhase

Return value

bool Whether the condition is valid.

ValidateBundleMsiPropertyName(sourceLineNumbers, elementName, attributeName, propertyName) Method

Validates an MsiProperty name value and displays an error for an illegal value.

Declaration

public bool ValidateBundleMsiPropertyName(
WixToolset.Data.SourceLineNumber sourceLineNumbers,
string elementName,
string attributeName,
string propertyName
)

Parameters

ParameterTypeDescription
sourceLineNumbersWixToolset.Data.SourceLineNumber
elementNamestring
attributeNamestring
propertyNamestring

Return value

bool Whether the name is valid.

ValidateBundleVariableNameDeclaration(sourceLineNumbers, elementName, attributeName, variableName) Method

Validates a Bundle variable name that is being used to declare a Variable in the bundle manifest and displays an error for an illegal value.

Declaration

public bool ValidateBundleVariableNameDeclaration(
WixToolset.Data.SourceLineNumber sourceLineNumbers,
string elementName,
string attributeName,
string variableName
)

Parameters

ParameterTypeDescription
sourceLineNumbersWixToolset.Data.SourceLineNumber
elementNamestring
attributeNamestring
variableNamestring

Return value

bool Whether the name is valid.

ValidateBundleVariableNameTarget(sourceLineNumbers, elementName, attributeName, variableName) Method

Validates a Bundle variable name that is being used to set its value and displays an error for an illegal value.

Declaration

public bool ValidateBundleVariableNameTarget(
WixToolset.Data.SourceLineNumber sourceLineNumbers,
string elementName,
string attributeName,
string variableName
)

Parameters

ParameterTypeDescription
sourceLineNumbersWixToolset.Data.SourceLineNumber
elementNamestring
attributeNamestring
variableNamestring

Return value

bool Whether the name is valid.

ValidateBundleVariableNameValue(sourceLineNumbers, elementName, attributeName, variableName, nameRule) Method

Validates a Bundle variable name that is being used to reference a Variable and displays an error for an illegal value.

Declaration

public bool ValidateBundleVariableNameValue(
WixToolset.Data.SourceLineNumber sourceLineNumbers,
string elementName,
string attributeName,
string variableName,
WixToolset.Extensibility.Data.BundleVariableNameRule nameRule
)

Parameters

ParameterTypeDescription
sourceLineNumbersWixToolset.Data.SourceLineNumber
elementNamestring
attributeNamestring
variableNamestring
nameRuleWixToolset.Extensibility.Data.BundleVariableNameRule

Return value

bool Whether the name is valid.