.NET Framework Class Library
ConnectionOptions Class
Specifies all settings required to make a WMI connection.
Inheritance Hierarchy
System.Object
System.Management.ManagementOptions
System.Management.ConnectionOptions
Namespace: System.Management
Assembly: System.Management (in System.Management.dll)
Syntax
Visual Basic
Public Class ConnectionOptions _ Inherits ManagementOptions
C#
public class ConnectionOptions : ManagementOptions
Visual C++
public ref class ConnectionOptions : public ManagementOptions
F#
type ConnectionOptions = class inherit ManagementOptions end
The ConnectionOptions type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
ConnectionOptions() | Initializes a new instance of the ConnectionOptions class for the connection operation, using default values. This is the default constructor. |
|
ConnectionOptions(String, String, SecureString, String, ImpersonationLevel, AuthenticationLevel, Boolean, ManagementNamedValueCollection, TimeSpan) | Creates a new ConnectionOption. |
|
ConnectionOptions(String, String, String, String, ImpersonationLevel, AuthenticationLevel, Boolean, ManagementNamedValueCollection, TimeSpan) | Initializes a new instance of the ConnectionOptions class to be used for a WMI connection, using the specified values. |
Properties
| Name | Description | |
|---|---|---|
|
Authentication | Gets or sets the COM authentication level to be used for operations in this connection. |
|
Authority | Gets or sets the authority to be used to authenticate the specified user. |
|
Context | Gets or sets a WMI context object. This is a name-value pairs list to be passed through to a WMI provider that supports context information for customized operation. (Inherited from ManagementOptions.) |
|
EnablePrivileges | Gets or sets a value indicating whether user privileges need to be enabled for the connection operation. This property should only be used when the operation performed requires a certain user privilege to be enabled (for example, a machine restart). |
|
Impersonation | Gets or sets the COM impersonation level to be used for operations in this connection. |
|
Locale | Gets or sets the locale to be used for the connection operation. |
|
Password | Sets the password for the specified user. |
|
SecurePassword | Sets the password for the specified user. |
|
Timeout | Gets or sets the time-out to apply to the operation. Note that for operations that return collections, this time-out applies to the enumeration through the resulting collection, not the operation itself (the ReturnImmediately property is used for the latter). This property is used to indicate that the operation should be performed semi-synchronously. (Inherited from ManagementOptions.) |
|
Username | Gets or sets the user name to be used for the connection operation. |
Methods
| Name | Description | |
|---|---|---|
|
Clone | Returns a copy of the object. (Overrides ManagementOptions.Clone().) |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Examples
The following example connects to a remote computer and displays information about the operating system on the remote computer. A ConnectionOptions is created to connect to the remote computer with default connection options.
Visual Basic
Imports System Imports System.Management Public Class RemoteConnect Public Overloads Shared Function Main( _ ByVal args() As String) As Integer ' Build an options object for the remote connection ' if you plan to connect to the remote ' computer with a different user name ' and password than the one you are currently using Dim options As ConnectionOptions options = New ConnectionOptions ' Make a connection to a remote computer. ' Replace the "FullComputerName" section of the ' string "\\FullComputerName\root\cimv2" with ' the full computer name or IP address of the ' remote computer. Dim scope As ManagementScope scope = New ManagementScope( _ "\\FullComputerName\root\cimv2", options) scope.Connect() ' Query system for Operating System information Dim query As ObjectQuery query = New ObjectQuery( _ "SELECT * FROM Win32_OperatingSystem") Dim searcher As ManagementObjectSearcher searcher = _ New ManagementObjectSearcher(scope, query) Dim queryCollection As ManagementObjectCollection queryCollection = searcher.Get() Dim m As ManagementObject For Each m In queryCollection ' Display the remote computer information Console.WriteLine("Computer Name : {0}", _ m("csname")) Console.WriteLine("Windows Directory : {0}", _ m("WindowsDirectory")) Console.WriteLine("Operating System: {0}", _ m("Caption")) Console.WriteLine("Version: {0}", m("Version")) Console.WriteLine("Manufacturer : {0}", _ m("Manufacturer")) Next Return 0 End Function End Class
C#
using System; using System.Management; public class RemoteConnect { public static void Main() { // Build an options object for the remote connection // if you plan to connect to the remote // computer with a different user name // and password than the one you are currently using. // This example uses the default values. ConnectionOptions options = new ConnectionOptions(); // Make a connection to a remote computer. // Replace the "FullComputerName" section of the // string "\\\\FullComputerName\\root\\cimv2" with // the full computer name or IP address of the // remote computer. ManagementScope scope = new ManagementScope( "\\\\FullComputerName\\root\\cimv2", options); scope.Connect(); //Query system for Operating System information ObjectQuery query = new ObjectQuery( "SELECT * FROM Win32_OperatingSystem"); ManagementObjectSearcher searcher = new ManagementObjectSearcher(scope,query); ManagementObjectCollection queryCollection = searcher.Get(); foreach ( ManagementObject m in queryCollection) { // Display the remote computer information Console.WriteLine("Computer Name : {0}", m["csname"]); Console.WriteLine("Windows Directory : {0}", m["WindowsDirectory"]); Console.WriteLine("Operating System: {0}", m["Caption"]); Console.WriteLine("Version: {0}", m["Version"]); Console.WriteLine("Manufacturer : {0}", m["Manufacturer"]); } } }
Version Information
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0.NET Framework Client Profile
Supported in: 4, 3.5 SP1Platforms
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.See Also