ClientProtocol ClientProtocol ClientProtocol Class

Definition

The ClientProtocol class represents a network protocol installed on a client instance that allows communication with the instance of SQL Server over a network.

public ref class ClientProtocol sealed : Microsoft::SqlServer::Management::Smo::Wmi::ProtocolBase
public sealed class ClientProtocol : Microsoft.SqlServer.Management.Smo.Wmi.ProtocolBase
Public NotInheritable Class ClientProtocol
Inherits ProtocolBase
Inheritance

Examples

Managing Services and Network Settings by Using WMI Provider

Remarks

With the ClientProtocol class you can:

  • Modify the display name of the protocol.

  • Enable or disable the protocol.

  • View the client network library name.

  • Modify the order in which the protocol is listed and applied.

  • Create a set of attributes for the protocol.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Properties

DisplayName DisplayName DisplayName

Gets or sets the display name of the referenced protocol.

IsEnabled IsEnabled IsEnabled

Gets or sets the Boolean property that specifies whether the client network protocol is enabled or disabled.

Name Name Name

Gets or sets the name of the referenced Windows Management Instrumentation (WMI) object.

(Inherited from WmiSmoObject)
NetLibInfo NetLibInfo NetLibInfo

Gets the network library information file for the referenced protocol.

NetworkLibrary NetworkLibrary NetworkLibrary

Gets the network library file name for the referenced protocol.

Order Order Order

Gets or sets the order in which the referenced protocol is listed and applied in relation to the other currently supported protocols.

Parent Parent Parent

Gets the ManagedComputer object that is the parent of the ClientProtocol object.

Properties Properties Properties

Represents a collection of Property objects. Each Property object represents a property defined on the Windows Management Instrumentation (WMI) object.

(Inherited from WmiSmoObject)
ProtocolProperties ProtocolProperties ProtocolProperties

Represents a collection of ProtocolProperty objects. Each ProtocolProperty object represents an attribute defined on the referenced protocol.

(Inherited from ProtocolBase)
State State State

Gets the state of the referenced object.

(Inherited from SmoObjectBase)
Urn Urn Urn

Gets the Uniform Resource Name (URN) address that represents the Windows Management Instrumentation (WMI) object.

(Inherited from WmiSmoObject)
UserData UserData UserData

Gets or sets user-defined data associated with the referenced object.

(Inherited from SmoObjectBase)

Methods

Alter() Alter() Alter()

Updates any Protocol object property changes on an instance of SQL Server.

(Inherited from ProtocolBase)
AlterProtocolProperties(ProtocolPropertyCollection) AlterProtocolProperties(ProtocolPropertyCollection) AlterProtocolProperties(ProtocolPropertyCollection)

Updates any protocol object property changes on the Windows Management Instrumentation (WMI) installation.

(Inherited from WmiSmoObject)
CheckObjectState() CheckObjectState() CheckObjectState()

Checks the state of the referenced object.

(Inherited from WmiSmoObject)
CreateProtocolPropertyCollection() CreateProtocolPropertyCollection() CreateProtocolPropertyCollection()

Creates a set of protocol attributes for the referenced object.

(Inherited from WmiSmoObject)
GetManagementObject() GetManagementObject() GetManagementObject()

Returns the object that manages the referenced protocol object.

(Inherited from ProtocolBase)
GetPropertyManagementObject(ProtocolProperty) GetPropertyManagementObject(ProtocolProperty) GetPropertyManagementObject(ProtocolProperty)

Gets the management object for the specified protocol property.

(Inherited from WmiSmoObject)
GetPropertyObject(PropertyCollection, DataRow, Object) GetPropertyObject(PropertyCollection, DataRow, Object) GetPropertyObject(PropertyCollection, DataRow, Object)

Gets the property from the specified collection with the specified position and value.

(Inherited from WmiSmoObject)
GetProtocolPropertyCollection() GetProtocolPropertyCollection() GetProtocolPropertyCollection()

Returns the protocol property collection for the referenced object.

(Inherited from WmiSmoObject)
ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[])

Initializes the fields of the WmiSmoObject object.

(Inherited from WmiSmoObject)
Initialize() Initialize() Initialize()

Initializes the referenced object.

(Inherited from WmiSmoObject)
InvokeMgmtMethod(ManagementObject, ManagementOperationObserver, String, Object[]) InvokeMgmtMethod(ManagementObject, ManagementOperationObserver, String, Object[]) InvokeMgmtMethod(ManagementObject, ManagementOperationObserver, String, Object[])

Invokes the management method for the referenced object with the specified management object, observer, method name, and parameters.

(Inherited from WmiSmoObject)
InvokeMgmtMethod(ManagementObject, String, Object[]) InvokeMgmtMethod(ManagementObject, String, Object[]) InvokeMgmtMethod(ManagementObject, String, Object[])

Invokes the management method for the referenced object with the specified management object, method name, and parameters.

(Inherited from WmiSmoObject)
IsObjectInitialized() IsObjectInitialized() IsObjectInitialized()

Specifies whether the referenced object is initialized.

(Inherited from WmiSmoObject)
Refresh() Refresh() Refresh()

Refreshes the objects and properties on the ClientProtocol object.

SetName(String) SetName(String) SetName(String)

Sets the name of the referenced object.

(Inherited from WmiSmoObject)
SetParentImpl(WmiSmoObject) SetParentImpl(WmiSmoObject) SetParentImpl(WmiSmoObject)

Sets the parent of the referenced object.

(Inherited from WmiSmoObject)
UpdateObjectState() UpdateObjectState() UpdateObjectState()

Updates the object state.

(Inherited from WmiSmoObject)
Validate(String, Object[]) Validate(String, Object[]) Validate(String, Object[])

Validates the state of an object.

(Inherited from SmoObjectBase)

Applies to