Vanara/System/readme.md

102 lines
18 KiB
Markdown
Raw Normal View History

## Assembly report for Vanara.SystemServices.dll
2020-08-26 23:03:04 -04:00
Classes for system related items derived from the Vanara PInvoke libraries. Includes extensions for Process (privileges and elavation), FileInfo (compression info), Shared Network Drives and Devices, and ServiceController (SetStartType) that pull extended information through native API calls.
### Enumerations
2019-09-05 23:03:18 -04:00
Enum | Description | Values
---- | ---- | ----
2020-07-14 17:07:18 -04:00
[Vanara.Diagnostics.BatteryStatus](https://github.com/dahall/Vanara/search?l=C%23&q=BatteryStatus) | Indicates the status of the battery. | NotPresent, Discharging, Idle, Charging
2022-10-25 13:24:54 -04:00
[Vanara.Network.EdgeTraversalType](https://github.com/dahall/Vanara/search?l=C%23&q=EdgeTraversalType) | Specifies the conditions under which edge traversal traffic is allowed. | Deny, Allow, DeferToApp, DeferToUser
2020-07-14 17:07:18 -04:00
[Vanara.Diagnostics.EnergySaverStatus](https://github.com/dahall/Vanara/search?l=C%23&q=EnergySaverStatus) | Specifies the status of battery saver. | Disabled, Off, On
2022-10-25 13:24:54 -04:00
[Vanara.Network.FirewallAction](https://github.com/dahall/Vanara/search?l=C%23&q=FirewallAction) | Specifies the action for a rule or default setting. | Block, Allow, Max
[Vanara.Network.FirewallAuthenticateType](https://github.com/dahall/Vanara/search?l=C%23&q=FirewallAuthenticateType) | Specifies the type of authentication which must occur in order for traffic to be allowed. | None, NoEncapsulation, WithIntegrity, NegotiateEncryption, Encrypt
[Vanara.Network.FirewallPolicyModifyState](https://github.com/dahall/Vanara/search?l=C%23&q=FirewallPolicyModifyState) | Specifies the effect of modifications to the current policy. | Ok, OverrideGroupPolicy, InboundBlocked
[Vanara.Network.FirewallProfileType](https://github.com/dahall/Vanara/search?l=C%23&q=FirewallProfileType) | Specifies the type of profile. | Domain, Private, Public, All
2020-07-14 17:07:18 -04:00
[Vanara.Diagnostics.JobLimit](https://github.com/dahall/Vanara/search?l=C%23&q=JobLimit) | The job limit type exceeded as communicated by a `Vanara.Diagnostics.JobNotificationEventArgs`. | PerJobUserTime, JobMemory, JobLowMemory, IoReadBytes, IoWriteBytes, RateControlTolerance, IoRateControlTolerance, NetRateControlTolerance
[Vanara.Extensions.NetworkInterfaceAccessType](https://github.com/dahall/Vanara/search?l=C%23&q=NetworkInterfaceAccessType) | The interface access type. | Loopback, Broadcast, PointToPoint, PointToMultiPoint
[Vanara.Extensions.NetworkInterfaceAdministrativeStatus](https://github.com/dahall/Vanara/search?l=C%23&q=NetworkInterfaceAdministrativeStatus) | Specifies the NDIS network interface administrative status, as described in RFC 2863. | Up, Down, Testing
[Vanara.Extensions.NetworkInterfaceConnectionType](https://github.com/dahall/Vanara/search?l=C%23&q=NetworkInterfaceConnectionType) | Specifies the NDIS network interface connection type. | Dedicated, Passive, Demand
[Vanara.Extensions.NetworkInterfaceDirectionType](https://github.com/dahall/Vanara/search?l=C%23&q=NetworkInterfaceDirectionType) | Specifies the NDIS network interface direction type. | SendReceive, SendOnly, ReceiveOnly
[Vanara.Extensions.NetworkInterfaceMediaType](https://github.com/dahall/Vanara/search?l=C%23&q=NetworkInterfaceMediaType) | The NDIS media type of a network interface. | Ethernet802_3, TokenRing, Fddi, Wan, LocalTalk, Dix, ArcnetRaw, Arcnet878_2, Atm, Wireless, IrDA, Broadcast, CoWAN, Ieee1394, InfiniBand, Tunnel, Native802_11, Loopback, WiMAX, IP
[Vanara.Extensions.NetworkInterfacePhysicalMedium](https://github.com/dahall/Vanara/search?l=C%23&q=NetworkInterfacePhysicalMedium) | The NDIS physical medium type. | Unspecified, WirelessLan, CableModem, PhoneLine, PowerLine, DSL, FibreChannel, Ieee1394, WirelessWan, Native802_11, Bluetooth, InfiniBand, WiMAX, UWB, Ethernet802_3, TokenRing, IrDA, WiredWAN, WiredCoWAN, Other
[Vanara.IO.PathEx.PathCharType](https://github.com/dahall/Vanara/search?l=C%23&q=PathCharType) | The type of character retrieved from `Vanara.IO.PathEx.GetCharType(System.Char)`. | Invalid, LongFileName, ShortFileName, Wildcard, Separator
[Vanara.Diagnostics.PowerCapabilities](https://github.com/dahall/Vanara/search?l=C%23&q=PowerCapabilities) | Specifies the power capabilities of a device. | PowerButtonPresent, SleepButtonPresent, LidPresent, SystemS1, SystemS2, SystemS3, SystemS4, SystemS5, HiberFilePresent, FullWake, VideoDimPresent, ApmPresent, UpsPresent, ThermalControl, ProcessorThrottle, FastSystemS4, Hiberboot, WakeAlarmPresent, AoAc, DiskSpinDown, AoAcConnectivitySupported, SystemBatteriesPresent, BatteriesAreShortTerm
[Vanara.Diagnostics.PowerSupplyStatus](https://github.com/dahall/Vanara/search?l=C%23&q=PowerSupplyStatus) | Represents the device's power supply status. | NotPresent, Inadequate, Adequate
2022-10-25 13:24:54 -04:00
[Vanara.Network.RuleDirection](https://github.com/dahall/Vanara/search?l=C%23&q=RuleDirection) | Specifies the direction of traffic to which a rule applies. | In, Out
[Vanara.Network.RuleInterfaceType](https://github.com/dahall/Vanara/search?l=C%23&q=RuleInterfaceType) | Specifies the interface types to which a rule applies. | All, Lan, RemoteAccess, Wireless
2022-05-04 19:25:17 -04:00
[Vanara.PInvoke.Diagnostics.ScanResult](https://github.com/dahall/Vanara/search?l=C%23&q=ScanResult) | The <c>ScanResult</c> enumeration specifies the types of results returned by scans. | Clean, NotDetected, PotentialDetected, Detected
2020-07-14 17:07:18 -04:00
[Vanara.Security.AccessControl.ServiceControllerAccessRights](https://github.com/dahall/Vanara/search?l=C%23&q=ServiceControllerAccessRights) | Defines the access rights to use when creating access and audit rules. | QueryConfig, ChangeConfig, QueryStatus, EnumerateDependents, Start, Stop, Continue, Interrogate, UserDefinedControl, Delete, ReadPermissions, Write, Read, Execute, ChangePermissions, TakeOwnership, AccessSystemSecurity, FullControl
[Vanara.ShareOfflineSettings](https://github.com/dahall/Vanara/search?l=C%23&q=ShareOfflineSettings) | Offline settings for a shared folder. | OnlySpecified, All, AllOptimized, None
### Interfaces
2019-09-05 23:03:18 -04:00
Interface | Description
---- | ----
2020-07-14 17:07:18 -04:00
[Vanara.Network.NetworkListManager.IEnumerableList<T>](https://github.com/dahall/Vanara/search?l=C%23&q=IEnumerableList<T>) | An enumerable list that supports a length and indexer.
[Vanara.INamedEntity](https://github.com/dahall/Vanara/search?l=C%23&q=INamedEntity) | An object that exposes a name.
[Vanara.Diagnostics.IPropertyProvider<T>](https://github.com/dahall/Vanara/search?l=C%23&q=IPropertyProvider<T>) | A dictionary of properties.
### Classes
2019-09-05 23:03:18 -04:00
Class | Description
---- | ----
2022-05-04 19:25:17 -04:00
[Vanara.PInvoke.Diagnostics.AntimalwareScan](https://github.com/dahall/Vanara/search?l=C%23&q=AntimalwareScan) | Provides scanning of strings and buffers to detect malware using either the system provider or a custom provider.
2020-07-14 17:07:18 -04:00
[Vanara.Computer](https://github.com/dahall/Vanara/search?l=C%23&q=Computer) | Represents a single connected (authenticated) computer.
[Vanara.Diagnostics.Device](https://github.com/dahall/Vanara/search?l=C%23&q=Device) | A class that represents a device on a machine.
[Vanara.Diagnostics.DeviceClass](https://github.com/dahall/Vanara/search?l=C%23&q=DeviceClass) | A class that provides detail about a device setup class available on a machine.
[Vanara.Diagnostics.DeviceClassCollection](https://github.com/dahall/Vanara/search?l=C%23&q=DeviceClassCollection) | A class that provides the collection of device setup classes available on a machine.
[Vanara.Diagnostics.DeviceClass.DeviceClassProperties](https://github.com/dahall/Vanara/search?l=C%23&q=DeviceClassProperties) | Accesses properties with a device class.
[Vanara.Diagnostics.DeviceClass.DeviceClassRegProperties](https://github.com/dahall/Vanara/search?l=C%23&q=DeviceClassRegProperties) | Accesses registry properties with a device class.
[Vanara.Diagnostics.DeviceCollection](https://github.com/dahall/Vanara/search?l=C%23&q=DeviceCollection) | A class that provides the collection of devices available on a machine.
[Vanara.Diagnostics.DeviceExtensions](https://github.com/dahall/Vanara/search?l=C%23&q=DeviceExtensions) | Extension methods for SetupAPI functions and structs.
[Vanara.Diagnostics.DeviceManager](https://github.com/dahall/Vanara/search?l=C%23&q=DeviceManager) | Class to manage local and remote devices.
[Vanara.Diagnostics.Device.DeviceProperties](https://github.com/dahall/Vanara/search?l=C%23&q=DeviceProperties) | Accesses properties with a device.
[Vanara.Diagnostics.Device.DeviceRegProperties](https://github.com/dahall/Vanara/search?l=C%23&q=DeviceRegProperties) | Accesses registry properties with a device class.
2020-07-14 17:07:18 -04:00
[Vanara.Extensions.FileInfoExtension](https://github.com/dahall/Vanara/search?l=C%23&q=FileInfoExtension) | Extension methods for `System.IO.FileSystemInfo` and derived classes to facilitate retrieval of extended properties.
2022-10-25 13:24:54 -04:00
[Vanara.Network.FirewallProfile](https://github.com/dahall/Vanara/search?l=C%23&q=FirewallProfile) | Represents a profile of the Windows Firewall.
[Vanara.Network.FirewallRule](https://github.com/dahall/Vanara/search?l=C%23&q=FirewallRule) | Provides access to the properties of a firewall rule.
[Vanara.Network.FirewallRules](https://github.com/dahall/Vanara/search?l=C%23&q=FirewallRules) | Represents the rules for the Windows Firewall.
[Vanara.Network.InternetProxyOptions](https://github.com/dahall/Vanara/search?l=C%23&q=InternetProxyOptions) | Provides access to proxy settings for an internet connection.
2020-07-14 17:07:18 -04:00
[Vanara.Diagnostics.IoCompletionPort](https://github.com/dahall/Vanara/search?l=C%23&q=IoCompletionPort) | Represents a system I/O completion port.
[Vanara.Diagnostics.Job](https://github.com/dahall/Vanara/search?l=C%23&q=Job) | Represents a system Job Object that allows groups of processes to be managed as a unit. Job objects are nameable, securable, sharable objects that control attributes of the processes associated with them. Operations performed on a job object affect all processes associated with the job object. Examples include enforcing limits such as working set size and process priority or terminating all processes associated with a job. For more information see <a href="https://docs.microsoft.com/en-us/windows/win32/procthread/job-objects">Job Objects</a>.
[Vanara.Diagnostics.JobEventArgs](https://github.com/dahall/Vanara/search?l=C%23&q=JobEventArgs) | Contains information about a job object message.
[Vanara.Diagnostics.JobHelper](https://github.com/dahall/Vanara/search?l=C%23&q=JobHelper) | Base class for other classes that support the `Vanara.Diagnostics.Job` object.
[Vanara.Diagnostics.JobLimits](https://github.com/dahall/Vanara/search?l=C%23&q=JobLimits) | Settings for `Vanara.Diagnostics.Job` that set limits for different runtime values.
[Vanara.Diagnostics.JobNotificationEventArgs](https://github.com/dahall/Vanara/search?l=C%23&q=JobNotificationEventArgs) | Contains information about a job object limit notification message.
[Vanara.Diagnostics.JobNotifications](https://github.com/dahall/Vanara/search?l=C%23&q=JobNotifications) | Settings for `Vanara.Diagnostics.Job` that set notification limits for different properties.
[Vanara.Diagnostics.JobSecurity](https://github.com/dahall/Vanara/search?l=C%23&q=JobSecurity) | Represents the security access rights of a job object.
[Vanara.Diagnostics.JobSettings](https://github.com/dahall/Vanara/search?l=C%23&q=JobSettings) | Settings related to job objects.
[Vanara.Diagnostics.JobStatistics](https://github.com/dahall/Vanara/search?l=C%23&q=JobStatistics) | Gets statistics for a job object.
2021-10-26 09:34:54 -04:00
[Vanara.LocalGroup](https://github.com/dahall/Vanara/search?l=C%23&q=LocalGroup) | Represents a local group on a server.
[Vanara.LocalGroupMembers](https://github.com/dahall/Vanara/search?l=C%23&q=LocalGroupMembers) | Represents a colleciton of local group members.
[Vanara.LocalGroups](https://github.com/dahall/Vanara/search?l=C%23&q=LocalGroups) | Represents the collection of local groups on a server.
2020-07-14 17:07:18 -04:00
[Vanara.Network.NetworkConnection](https://github.com/dahall/Vanara/search?l=C%23&q=NetworkConnection) | Represents a single network connection. Wraps `Vanara.PInvoke.NetListMgr.INetworkConnection`.
2020-09-07 13:05:38 -04:00
[Vanara.NetworkDeviceConnection](https://github.com/dahall/Vanara/search?l=C%23&q=NetworkDeviceConnection) | Information about a remote resource, usually in reference to a connection to that resource.
[Vanara.NetworkDeviceConnectionCollection](https://github.com/dahall/Vanara/search?l=C%23&q=NetworkDeviceConnectionCollection) | Provides access to the local machine's remote connections.
2020-07-14 17:07:18 -04:00
[Vanara.Extensions.NetworkInterfaceExt](https://github.com/dahall/Vanara/search?l=C%23&q=NetworkInterfaceExt) | Extension methods for various network related interfaces methods.
[Vanara.Network.NetworkListManager](https://github.com/dahall/Vanara/search?l=C%23&q=NetworkListManager) | Provides a set of methods to perform network list management functions.
[Vanara.Network.NetworkProfile](https://github.com/dahall/Vanara/search?l=C%23&q=NetworkProfile) | Represents a wireless network profile
[Vanara.OpenFile](https://github.com/dahall/Vanara/search?l=C%23&q=OpenFile) | Represents an open file associated with a share.
[Vanara.IO.PathEx](https://github.com/dahall/Vanara/search?l=C%23&q=PathEx) | Performs operations on String instances that contain file or directory path information. These operations are performed in a cross-platform manner.
[Vanara.Diagnostics.PoweredDevice](https://github.com/dahall/Vanara/search?l=C%23&q=PoweredDevice) | Represents a device on the system that has power requirements.
[Vanara.Diagnostics.PoweredDeviceCollection](https://github.com/dahall/Vanara/search?l=C%23&q=PoweredDeviceCollection) | Retrieves the list, optionally filtered, of the powered devices on the system.
2020-12-26 13:07:30 -05:00
[Vanara.Diagnostics.PowerEventArgs<T>](https://github.com/dahall/Vanara/search?l=C%23&q=PowerEventArgs<T>) | Event arguments for power events.
2020-07-14 17:07:18 -04:00
[Vanara.Diagnostics.PowerManager](https://github.com/dahall/Vanara/search?l=C%23&q=PowerManager) | Provides access to information about a device's battery and power supply status and configuration. This extends the capabilities Windows.System.Power.PowerManager to include more detail, schemes and devices.
[Vanara.Diagnostics.PowerScheme](https://github.com/dahall/Vanara/search?l=C%23&q=PowerScheme) | Represents a system power scheme (power plan).
[Vanara.Diagnostics.PowerSchemeCollection](https://github.com/dahall/Vanara/search?l=C%23&q=PowerSchemeCollection) | Represents a collection of all the power schemes available on the system.
[Vanara.Diagnostics.PowerSchemeGroup](https://github.com/dahall/Vanara/search?l=C%23&q=PowerSchemeGroup) | Represents a subgroup of a system power scheme (power plan).
[Vanara.Diagnostics.PowerSchemeGroupCollection](https://github.com/dahall/Vanara/search?l=C%23&q=PowerSchemeGroupCollection) | Represents a collection of all the subgroups available under a power scheme on the system.
[Vanara.Diagnostics.PowerSchemeSetting](https://github.com/dahall/Vanara/search?l=C%23&q=PowerSchemeSetting) | Represents a setting on a subgroup.
[Vanara.Diagnostics.PowerSchemeSettingCollection](https://github.com/dahall/Vanara/search?l=C%23&q=PowerSchemeSettingCollection) | Represents a collection of all settings for a subgroup and power scheme on the system.
[Vanara.Extensions.ProcessExtension](https://github.com/dahall/Vanara/search?l=C%23&q=ProcessExtension) | Extension methods for `System.Diagnostics.Process` for privileges, status, elevation and relationships.
[Vanara.Registry.RegistryEventMonitor.RegistryEventArgs](https://github.com/dahall/Vanara/search?l=C%23&q=RegistryEventArgs) | Argument used in `Vanara.Registry.RegistryEventMonitor` events.
[Vanara.Registry.RegistryEventMonitor](https://github.com/dahall/Vanara/search?l=C%23&q=RegistryEventMonitor) | Watches the Windows Registry for any changes.
[Vanara.Security.AccessControl.ServiceControllerAccessRule](https://github.com/dahall/Vanara/search?l=C%23&q=ServiceControllerAccessRule) | Represents an abstraction of an access control entry (ACE) that defines an access rule for a service.
[Vanara.Security.AccessControl.ServiceControllerAuditRule](https://github.com/dahall/Vanara/search?l=C%23&q=ServiceControllerAuditRule) | Represents an abstraction of an access control entry (ACE) that defines an audit rule for a service.
[Vanara.Extensions.ServiceControllerExtension](https://github.com/dahall/Vanara/search?l=C%23&q=ServiceControllerExtension) | Extension methods for `System.ServiceProcess.ServiceController`.
[Vanara.Security.AccessControl.ServiceControllerSecurity](https://github.com/dahall/Vanara/search?l=C%23&q=ServiceControllerSecurity) | Represents the access control and audit security for a service.
2022-09-16 17:04:32 -04:00
[Vanara.Session](https://github.com/dahall/Vanara/search?l=C%23&q=Session) | Represents a Windows session.
[Vanara.Sessions](https://github.com/dahall/Vanara/search?l=C%23&q=Sessions) | A collection of Windows sessions for the specified target computer.
2020-07-14 17:07:18 -04:00
[Vanara.ShareConnection](https://github.com/dahall/Vanara/search?l=C%23&q=ShareConnection) | Represents a connection to a shared device.
[Vanara.SharedDevice](https://github.com/dahall/Vanara/search?l=C%23&q=SharedDevice) | Represents a shared device on a computer.
[Vanara.SharedDevices](https://github.com/dahall/Vanara/search?l=C%23&q=SharedDevices) | Represents all the shared devices on a computers.
[Vanara.Diagnostics.SystemShutdown](https://github.com/dahall/Vanara/search?l=C%23&q=SystemShutdown) | Provides access to system shutdown, restart, lock and notifications.
2021-10-26 09:34:54 -04:00
[Vanara.UserAccount](https://github.com/dahall/Vanara/search?l=C%23&q=UserAccount) | Represents a user account on a server.
[Vanara.UserAccounts](https://github.com/dahall/Vanara/search?l=C%23&q=UserAccounts) | Represents the collection of user accounts on a server.
2022-10-25 13:24:54 -04:00
[Vanara.Network.WindowsFirewall](https://github.com/dahall/Vanara/search?l=C%23&q=WindowsFirewall) | Wrapper for Windows Firewall interface methods (i.e. `Vanara.PInvoke.FirewallApi.INetFwPolicy2`).
2020-07-14 17:07:18 -04:00
[Vanara.IO.Wow64Redirect](https://github.com/dahall/Vanara/search?l=C%23&q=Wow64Redirect) | Suspends File System Redirection if found to be in effect. Effectively, this calls <c>IsWow64Process</c> to determine state and then disables redirection using <c>Wow64DisableWow64FsRedirection</c>. It then reverts redirection at disposal using <c>Wow64RevertWow64FsRedirection</c>.