ProtocolBase Class

Definition

The ProtocolBase class represents a protocol used on a SQL Server client or a server that is running SQL Server.

public ref class ProtocolBase abstract : Microsoft::SqlServer::Management::Smo::Wmi::WmiSmoObject, Microsoft::SqlServer::Management::Common::IAlterable
public abstract class ProtocolBase : Microsoft.SqlServer.Management.Smo.Wmi.WmiSmoObject, Microsoft.SqlServer.Management.Common.IAlterable
type ProtocolBase = class
    inherit WmiSmoObject
    interface IAlterable
Public MustInherit Class ProtocolBase
Inherits WmiSmoObject
Implements IAlterable
Inheritance
Derived
Implements

Examples

Managing Services and Network Settings by Using WMI Provider

Remarks

The ProtocolBase class is a base class used in the construction of the ClientProtocol object and the ServerProtocol object and contains functionality that is common to both.

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

Name

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

(Inherited from WmiSmoObject)
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.

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)

Methods

Alter()

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

AlterProtocolProperties(ProtocolPropertyCollection)

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

(Inherited from WmiSmoObject)
CheckObjectState()

Checks the state of the referenced object.

(Inherited from WmiSmoObject)
CreateProtocolPropertyCollection()

Creates a set of protocol attributes for the referenced object.

(Inherited from WmiSmoObject)
GetManagementObject()

Returns the object that manages the referenced protocol object.

GetPropertyManagementObject(ProtocolProperty)

Gets the management object for the specified protocol property.

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

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

(Inherited from WmiSmoObject)
GetProtocolPropertyCollection()

Returns the protocol property collection for the referenced object.

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

Initializes the fields of the WmiSmoObject object.

(Inherited from WmiSmoObject)
Initialize()

Initializes the referenced object.

(Inherited from WmiSmoObject)
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[])

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

(Inherited from WmiSmoObject)
IsObjectInitialized()

Specifies whether the referenced object is initialized.

(Inherited from WmiSmoObject)
Refresh()

Refreshes the properties of the referenced object.

SetName(String)

Sets the name of the referenced object.

(Inherited from WmiSmoObject)
SetParentImpl(WmiSmoObject)

Sets the parent of the referenced object.

(Inherited from WmiSmoObject)
UpdateObjectState()

Updates the object state.

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

Validates the state of an object.

(Inherited from SmoObjectBase)

Applies to