ProductManager.Load Method

Definition

Namespace:

Microsoft.Web.PlatformInstaller

Assembly:

Microsoft.Web.PlatformInstaller.dll

Loads data for the product manager.

Overloads

Load(Uri, Boolean, Boolean, Boolean, String, Architecture, Int32, Int32, Int32, Int32, Int32)	Loads product data specific to the current processor architecture and operating system from the specified productFileUrl. Optionally may load external file enclosures, use a cached file, and specify processor architecture and operating system version.
Load(Uri, Boolean, Boolean, Boolean, String)	Loads product data specific to the current processor architecture and operating system from the specified productFileUrl. Optionally may load external file enclosures and use a cached file.
Load(Uri, Boolean, Boolean)	Loads product data specific to the current processor architecture and operating system from the specified productFileUrl. Optionally may load external file enclosures.
Load(Uri, Boolean)	Loads product data specific to the current processor architecture and operating system from the specified productFileUrl.
Load(Uri)	Loads data for the product manager from the specified productFileUrl.

Load(Uri, Boolean, Boolean, Boolean, String, Architecture, Int32, Int32, Int32, Int32, Int32)

Loads product data specific to the current processor architecture and operating system from the specified productFileUrl. Optionally may load external file enclosures, use a cached file, and specify processor architecture and operating system version.

public:
 void Load(Uri ^ productFileUrl, bool filterByArchitectureAndOS, bool loadEnclosures, bool useCachedVersion, System::String ^ cacheDirectory, Microsoft::Web::PlatformInstaller::Architecture architecture, int majorOS, int minorOS, int majorSP, int minorSP, int osType);

public void Load (Uri productFileUrl, bool filterByArchitectureAndOS, bool loadEnclosures, bool useCachedVersion, string cacheDirectory, Microsoft.Web.PlatformInstaller.Architecture architecture, int majorOS, int minorOS, int majorSP, int minorSP, int osType);

member this.Load : Uri * bool * bool * bool * string * Microsoft.Web.PlatformInstaller.Architecture * int * int * int * int * int -> unit

Parameters

productFileUrl

Uri

A Uri where the product file is located.

filterByArchitectureAndOS

Boolean

Determines whether the product file should be filtered to include only those products available for the current processor architecture and operating system. true if the file should be filtered, otherwise false.

loadEnclosures

Boolean

Determines if the method should attempt to load external files specified in enclosures in the file represented by productFileUrl. true if the method should attempt to load external enclosures, otherwise false.

useCachedVersion

Boolean

Determines if cached data should be used or the file should be downloaded again. true if the method should use the cached version from a previous attempt, otherwise false.

cacheDirectory

String

The directory where cached schema files will be stored.

architecture

Architecture

The processor architecture to use when filtering the products.

majorOS

Int32

The major operating system version to use when filtering the products.

Note The minimum value is 6.

minorOS

Int32

The minor operating system version architecture to use when filtering the products.

Note The minimum value is 0.

majorSP

Int32

The major service pack version to use when filtering the products.

Note The minimum value is 0.

minorSP

Int32

The minor service pack version architecture to use when filtering the products.

Note The minimum value is 0.

osType

Int32

The operating system type to use when filtering the products.

Note Specifying 0 for this parameter will configure the Web Platform Installer to not filter products by operating system type.

Exceptions

ArgumentNullException

productFileUrl or cacheDirectory is null (Nothing in Visual Basic).

Remarks

An enclosure in the XML file tasks the form of:

<link rel='enclosure' href='<uri>'/>

The list of operating system types for the majorOS, minorOS, majorSP, minorSP, and osType parameters are available in the GetProductInfo Function topic.

Load(Uri, Boolean, Boolean, Boolean, String)

Loads product data specific to the current processor architecture and operating system from the specified productFileUrl. Optionally may load external file enclosures and use a cached file.

public:
 void Load(Uri ^ productFileUrl, bool filterByArchitectureAndOS, bool loadEnclosures, bool useCachedVersion, System::String ^ cacheDirectory);

public void Load (Uri productFileUrl, bool filterByArchitectureAndOS, bool loadEnclosures, bool useCachedVersion, string cacheDirectory);

member this.Load : Uri * bool * bool * bool * string -> unit

Public Sub Load (productFileUrl As Uri, filterByArchitectureAndOS As Boolean, loadEnclosures As Boolean, useCachedVersion As Boolean, cacheDirectory As String)

Parameters

productFileUrl

Uri

A Uri where the product file is located.

filterByArchitectureAndOS

Boolean

Determines whether the product file should be filtered to include only those products available for the current processor architecture and operating system. true if the file should be filtered, otherwise false.

loadEnclosures

Boolean

Determines if the method should attempt to load external files specified in enclosures in the file represented by productFileUrl. true if the method should attempt to load external enclosures, otherwise false.

useCachedVersion

Boolean

Determines if cached data should be used or the file should be downloaded again. true if the method should use the cached version from a previous attempt, otherwise false.

cacheDirectory

String

The directory where the cached data is located.

Exceptions

ArgumentNullException

productFileUrl or cacheDirectory are null (Nothing in Visual Basic).

Remarks

An enclosure in the XML file tasks the form of:

<link rel='enclosure' href='<uri>'/>

Note

Processor architecture is determined by evaluating the PROCESSOR_ARCHITECTURE key found in System\CurrentControlSet\Control\Session Manager\Environment.

Load(Uri, Boolean, Boolean)

Loads product data specific to the current processor architecture and operating system from the specified productFileUrl. Optionally may load external file enclosures.

public:
 void Load(Uri ^ productFileUrl, bool filterByArchitectureAndOS, bool loadEnclosures);

public void Load (Uri productFileUrl, bool filterByArchitectureAndOS, bool loadEnclosures);

member this.Load : Uri * bool * bool -> unit

Public Sub Load (productFileUrl As Uri, filterByArchitectureAndOS As Boolean, loadEnclosures As Boolean)

Parameters

productFileUrl

Uri

A Uri where the product file is located.

filterByArchitectureAndOS

Boolean

Determines whether the product file should be filtered to include only those products available for the current processor architecture and operating system. true if the file should be filtered, otherwise false.

loadEnclosures

Boolean

Determines if the method should attempt to load external files specified in enclosures in the file represented by productFileUrl. true if the method should attempt to load external enclosures, otherwise false.

Exceptions

ArgumentNullException

productFileUrl is null (Nothing in Visual Basic).

Remarks

An enclosure in the XML file tasks the form of:

<link rel='enclosure' href='<uri>'/>

Note

Processor architecture is determined by evaluating the PROCESSOR_ARCHITECTURE key found in System\CurrentControlSet\Control\Session Manager\Environment.

Load(Uri, Boolean)

Loads product data specific to the current processor architecture and operating system from the specified productFileUrl.

public:
 void Load(Uri ^ productFileUrl, bool filterByArchitectureAndOS);

public void Load (Uri productFileUrl, bool filterByArchitectureAndOS);

member this.Load : Uri * bool -> unit

Public Sub Load (productFileUrl As Uri, filterByArchitectureAndOS As Boolean)

Parameters

productFileUrl

Uri

A Uri where the product file is located.

filterByArchitectureAndOS

Boolean

Determines whether the product file should be filtered to include only those products available for the current processor architecture and operating system. true if the file should be filtered, otherwise false.

Exceptions

ArgumentNullException

productFileUrl is null (Nothing in Visual Basic).

Remarks

Note

Processor architecture is determined by evaluating the PROCESSOR_ARCHITECTURE key found in System\CurrentControlSet\Control\Session Manager\Environment.

Load(Uri)

Loads data for the product manager from the specified productFileUrl.

public:
 void Load(Uri ^ productFileUrl);

public void Load (Uri productFileUrl);

member this.Load : Uri -> unit

Public Sub Load (productFileUrl As Uri)

Parameters

productFileUrl

Uri

A Uri where the product file is located.

Exceptions

ArgumentNullException

productFileUrl is null (Nothing in Visual Basic).

Remarks

This method loads enclosures by default. An enclosure in the XML file tasks the form of:

<link rel='enclosure' href='<uri>'/>