Class WindowsShare

Namespace

CENTREL.XIA.Configuration.Types

Assembly

CENTREL.XIA.Configuration.Types.dll

Represents a shared resource such as a shared folder or printer on a Windows machine.

public class WindowsShare : GlobalSerializableClassicBase, IComparable<WindowsShare>

Inheritance

object

WindowsShare

Implements

IComparable<WindowsShare>

Constructors

WindowsShare()

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

public WindowsShare()

Properties

AllowMaximum

Gets or sets whether this share allows the maximum number of connections.

public BooleanOption AllowMaximum { get; set; }

Property Value

BooleanOption

CacheSetting

Gets or sets the cache configuration for this share.

public ShareCacheSetting CacheSetting { get; set; }

Property Value

ShareCacheSetting

CacheSettingString

Gets the cache configuration for this share as a human readable string.

public string CacheSettingString { get; }

Property Value

string

Description

Gets or sets the description of this Windows share.

public string Description { get; set; }

Property Value

string

DirectoryExists

Gets or sets whether the directory to which this share is bound exists.

public BooleanOption DirectoryExists { get; set; }

Property Value

BooleanOption

EnableAccessBasedEnumeration

Gets or sets whether access based enumeration is configured for this share. This determines if shares to which the user does not have permission should be hidden from the user.

public BooleanOption EnableAccessBasedEnumeration { get; set; }

Property Value

BooleanOption

EncryptData

Gets or sets whether data access to the share is encrypted. This property is only available when the shares are read using PowerShell remoting.

public BooleanOption EncryptData { get; set; }

Property Value

BooleanOption

IsDiskShare

Gets whether the share is a disk share (a shared folder).

public bool IsDiskShare { get; }

Property Value

bool

IsPrinterShare

Gets whether the share is a shared printer.

public bool IsPrinterShare { get; }

Property Value

bool

MaximumAllowed

Gets or sets the maximum number of connections allowed.

public int MaximumAllowed { get; set; }

Property Value

int

Name

Gets or sets the name of the share - for example "Admin$".

public string Name { get; set; }

Property Value

string

Path

Gets or sets the path to a shared resource - for example "D:\data\users".

public string Path { get; set; }

Property Value

string

Security

Gets or sets the NTFS permissions on the file system for this share. This applies to disk based shares including administrative shares only.

public NtfsSecurityDescriptor Security { get; set; }

Property Value

NtfsSecurityDescriptor

SharePermissions

Gets or sets the share level permissions assigned to this Windows share. This applies to disk based shares, not including administrative shares which control their own security.

public WindowsSharePermissions SharePermissions { get; set; }

Property Value

WindowsSharePermissions

ShareType

Gets or sets the type of Windows share - for example "DiskDrive" or "PrintQueue".

public WindowsShareType ShareType { get; set; }

Property Value

WindowsShareType

ShareTypeString

Gets the share type as a human readable string.

public string ShareTypeString { get; set; }

Property Value

string

Methods

CompareTo(WindowsShare)

Compares two CENTREL.XIA.Configuration.Types.WindowsShare objects allowing them to be sorted alphabetically by share name.

public int CompareTo(WindowsShare other)

Parameters

other WindowsShare

The CENTREL.XIA.Configuration.Types.WindowsShare to compare to.

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.WindowsShare objects.