Class WindowsServerFeatures

Namespace

CENTREL.XIA.Configuration.Types

Assembly

CENTREL.XIA.Configuration.Types.dll

Represents the server features, roles and role services installed on a Windows 2008 or above server.

public class WindowsServerFeatures : BypassSection

Inheritance

object

BaseTypeSection

BypassSection

WindowsServerFeatures

Inherited Members

BypassSection.Complete()

BypassSection.IsComplete

BypassSection.IsComponentDisabled

BypassSection.IsFailed

BypassSection.IsBypassed

BypassSection.IsNotAvailableOnObject

BypassSection.IsNotAvailableOnPlatform

BypassSection.IsNotInstalled

BypassSection.Status

BypassSection.StatusString

Constructors

WindowsServerFeatures()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.WindowsServerFeatures class.

public WindowsServerFeatures()

Properties

AvailableFeatures

Gets or sets whether features that are available but not installed are documented in the collection. By default this is false.

public BooleanOption AvailableFeatures { get; set; }

Property Value

BooleanOption

Items

Gets or sets the items within the collection.

public WindowsServerFeatureCollection Items { get; set; }

Property Value

WindowsServerFeatureCollection

Methods

FindById(int)

Returns the Windows server feature with the specified identifier or null if no feature with that identifier is found.

public WindowsServerFeature FindById(int id)

Parameters

id int

The unique identifier of the feature to locate.

Returns

WindowsServerFeature

A CENTREL.XIA.Configuration.Types.WindowsServerFeature with the specified identifier.

FindByParentId(int)

Returns a collection of the Windows server features that belong to the feature with the specified parent identifier. This should not be used for Windows Server 2012 or above.

public WindowsServerFeatureCollection FindByParentId(int parentId)

Parameters

parentId int

The unique identifier of the parent for which the features should be returned.

Returns

WindowsServerFeatureCollection

A CENTREL.XIA.Configuration.Types.WindowsServerFeatureCollection of the features with the specified parent identifier.

FindByParentId(int, bool)

Returns a collection of the Windows server features that belong to the feature with the specified parent identifier. This should not be used for Windows Server 2012 or above.

public WindowsServerFeatureCollection FindByParentId(int parentId, bool recurse)

Parameters

parentId int

The unique identifier of the parent for which the features should be returned.

recurse bool

Determines whether the system should recurse the children of the specified parent.

Returns

WindowsServerFeatureCollection

A CENTREL.XIA.Configuration.Types.WindowsServerFeatureCollection of the features with the specified parent identifier.

FindByParentUniqueName(string)

Returns a collection of the Windows server features that belong to the feature with the specified parent unique name. This method is supported on Windows Server 2012 and above.

public WindowsServerFeatureCollection FindByParentUniqueName(string parentUniqueName)

Parameters

parentUniqueName string

The unique name of the parent for which the features should be returned - for example "MultiPoint-Connector".

Returns

WindowsServerFeatureCollection

A CENTREL.XIA.Configuration.Types.WindowsServerFeatureCollection of the features with the specified parent unique name.

FindByParentUniqueName(string, bool)

Returns a collection of the Windows server features that belong to the feature with the specified parent unique name. This method is supported on Windows Server 2012 and above.

public WindowsServerFeatureCollection FindByParentUniqueName(string parentUniqueName, bool recurse)

Parameters

parentUniqueName string

The unique name of the parent for which the features should be returned - for example "MultiPoint-Connector".

recurse bool

Determines whether the system should recurse the children of the specified parent.

Returns

WindowsServerFeatureCollection

A CENTREL.XIA.Configuration.Types.WindowsServerFeatureCollection of the features with the specified parent unique name.

FindByUniqueName(string)

Returns the Windows server feature with the specified unique name or null if no feature with that unique name is found. This applies to Windows Server 2012 and above only.

public WindowsServerFeature FindByUniqueName(string uniqueName)

Parameters

uniqueName string

The unique name of the feature to locate.

Returns

WindowsServerFeature

A CENTREL.XIA.Configuration.Types.WindowsServerFeature with the specified unique name.

IsInstalled(int)

Determines whether the server feature with the specified identifier is installed.

public bool IsInstalled(int id)

Parameters

id int

The unique identifier of the feature to locate.

Returns

bool

A System.Boolean value that indicates whether the feature with the specified identifier is installed.

Remarks

From Windows Server 2012 and above it is possible to have features in the collection that are marked as not installed.

IsInstalled(string)

Determines whether the server feature with the specified unique name is installed. This applies to Windows Server 2012 and above only.

public bool IsInstalled(string uniqueName)

Parameters

uniqueName string

The unique name of the feature to locate - for example "XPS-Viewer".

Returns

bool

A System.Boolean value that indicates whether the feature with the specified unique name is installed.

ToString()

Returns the server features as a human readable string.

public override string ToString()

Returns

string

The server features as a human readable string.