ClientProtocol Class

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

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.Wmi.WmiSmoObject
      Microsoft.SqlServer.Management.Smo.Wmi.ProtocolBase
        Microsoft.SqlServer.Management.Smo.Wmi.ClientProtocol

Namespace:  Microsoft.SqlServer.Management.Smo.Wmi
Assembly:  Microsoft.SqlServer.SqlWmiManagement (in Microsoft.SqlServer.SqlWmiManagement.dll)

Syntax

'Declaration
Public NotInheritable Class ClientProtocol _
    Inherits ProtocolBase
'Usage
Dim instance As ClientProtocol

public sealed class ClientProtocol : ProtocolBase

public ref class ClientProtocol sealed : public ProtocolBase

[<SealedAttribute>]
type ClientProtocol =  
    class 
        inherit ProtocolBase 
    end

public final class ClientProtocol extends ProtocolBase

The ClientProtocol type exposes the following members.

Properties

	Name	Description
	DisplayName	Gets or sets the display name of the referenced protocol.
	IsEnabled	Gets or sets the Boolean property that specifies whether the client network protocol is enabled or disabled.
	Name	Gets or sets the name of the referenced Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
	NetLibInfo	Gets the network library information file for the referenced protocol.
	NetworkLibrary	Gets the network library file name for the referenced protocol.
	Order	Gets or sets the order in which the referenced protocol is listed and applied in relation to the other currently supported protocols.
	Parent	Gets the ManagedComputer object that is the parent of the ClientProtocol object.
	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	Represents a collection of ProtocolProperty objects. Each ProtocolProperty object represents an attribute defined on the referenced protocol. (Inherited from ProtocolBase.)
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address that represents the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Alter	Updates any Protocol object property changes on an instance of SQL Server. (Inherited from ProtocolBase.)
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Initialize	Initializes the referenced object. (Inherited from WmiSmoObject.)
	IsObjectInitialized	Specifies whether the referenced object is initialized. (Inherited from WmiSmoObject.)
	Refresh	Refreshes the objects and properties on the ClientProtocol object. (Overrides ProtocolBase.Refresh().)
	SetName	Sets the name of the referenced object. (Inherited from WmiSmoObject.)
	SetParentImpl	Sets the parent of the referenced object. (Inherited from WmiSmoObject.)
	ToString	(Inherited from Object.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

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.

Examples

Managing Services and Network Settings by Using WMI Provider

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

Reference

Microsoft.SqlServer.Management.Smo.Wmi Namespace

Other Resources

WMI and SQL Server

Connecting to the SQL Server Database Engine