GetOption Method (optionName, parameters)

Microsoft Deployment Tools

Deployment Tools Foundation GetOption Method (optionName, parameters)

Gets extended parameter information specific to the compression format being used.

Declaration Syntax

Visual Basic

Visual C++

Object GetOption(
	string optionName,
	Object[] parameters
)

Function GetOption ( _
	optionName As String, _
	parameters As Object() _
) As Object

Object^ GetOption(
	String^ optionName, 
	array<Object^>^ parameters
)

Parameters

optionName (String): Name of the option being requested.

parameters (array< Object >[]()[]): Parameters for the option; for per-file options, the first parameter is typically the internal file path.

Return Value

Option value, or null to use the default behavior.

Remarks

This method provides a way to set uncommon options during packaging, or a way to handle aspects of compression formats not supported by the base library.

For example, this may be used by the zip compression library to specify different compression methods/levels on a per-file basis.

The available option names, parameters, and expected return values should be documented by each compression library.

Assembly: Microsoft.Deployment.Compression (Module: Microsoft.Deployment.Compression) Version: 3.0.0.0 (3.5.1623.0)

previous page start next page