Package Class

Package Class

Provides information related to installed (MSI) package. Package consists of either a single application or a set of application modules (a.k.a. extensions). This class is compliant with general installation guidelines. It means that it's dependand on the package installation routine, and vice-versa.

Inheritance Hierarchy

SystemObject
FDF.CommonPackage

Namespace: FDF.Common
Assembly: FDF.Common (in FDF.Common.dll) Version: 3.0.0.0

Syntax

C++

Copy

public sealed class Package

Public NotInheritable Class Package

public ref class Package sealed

[<SealedAttribute>]
type Package =  class end

The Package type exposes the following members.

Constructors

	Name	Description
	Package	Initializes a new instance of the Package class

Top

Properties

	Name	Description
	Components	Returns preinstalled package components (application modules).
	Credentials	Returns package credentials settings.
	Debug	Returns package debugger settings.
	Extensions	Returns registered package extensions (custom application modules).
	Features	Returns preinstalled package features (MSI).
	Folders	Returns preinstalled package folders.
	Host	Gets or sets application's host type.
	HostName	Returns application's host name.
	Language	Returns package language abbreviation.
	License	Returns package license settings.
	LocalMachineKey	Returns root HKEY_LOCAL_MACHINE path to the package registry key.
	Manufacturer	Returns package manufacturer name.
	ManufacturerSupportUrl	Returns package manufacturer's support URL address.
	ManufacturerUrl	Returns package manufacturer's URL address.
	MaxCores	Gets or sets maximum number of utilized cores. If less or equal than 0 then all available cores will be used.
	MaxErrors	Gets or sets maximum number of errors being spawned.
	Organization	Returns registered organization (company) name.
	PartialMenus	Returns preinstalled package CUI partial menus.
	Platform	Returns package target platform architecture.
	ProductCode	Returns package product code (GUID).
	ProductName	Returns package product name.
	ProductTitle	Returns package product title.
	Proxy	Returns package proxy server settings.
	Release	Returns package release version.
	Resources	Returns preinstalled package resources.
	Settings	Returns current user's settings.
	Update	Returns package update server settings.
	UserName	Returns registered user name.
	UserNameSystem	Returns OS current user name.

Top

Methods

	Name	Description
	EnsureHostInstance	Returns True if no host application(s) interfere with running instance, otherwise returns False.
	EnsureSingleInstance	Returns True if this application has no multiple instances running, otherwise returns False.
	GetHelpTopicUrl
	GetPackageStringValue	Returns string value from package.ini file.
	GetTypeInstance
	HasHost(MsiHostType)	Returns True if application runs on specified host, otherwise returns False.
	HasHost(MsiHostType)	Returns True if application runs on any of the specified hosts, otherwise returns False.
	Initialize(Form)
	Initialize(Boolean, Boolean, Boolean, Boolean, Boolean)	Initializes this package.
	Initialize(IntPtr, Boolean, Boolean, Boolean, Boolean)
	Initialize2
	InitializeInternals
	OpenHelpTopicUrl
	OpenUrl
	RunProcess	Runs specified process within a package domain. Returns True if process ran fine, otherwise returns False.
	TryGetProcessOutput

Top

Events

	Name	Description
	ComponentLoaded	Raised if preinstalled component gets successfully loaded.
	ComponentLoading
	ExtensionLoaded	Raised if extension gets successfully loaded.
	ExtensionLoadingFailed	Raised if extension loading fails.

Top

Remarks

Do not hard-code file and folder paths in your application - rather utilize this class to get predefined locations and data. This is recommended way of getting package information since installation procedure is subject to regular change.

Reference

FDF.Common Namespace