• Article

ProtocolBase Class

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

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

Syntax

'Declaration
Public MustInherit Class ProtocolBase _
    Inherits WmiSmoObject _
    Implements IAlterable
'Usage
Dim instance As ProtocolBase

public abstract class ProtocolBase : WmiSmoObject, 
    IAlterable

public ref class ProtocolBase abstract : public WmiSmoObject, 
    IAlterable

[<AbstractClassAttribute>]
type ProtocolBase =  
    class
        inherit WmiSmoObject
        interface IAlterable
    end

public abstract class ProtocolBase extends WmiSmoObject implements IAlterable

The ProtocolBase type exposes the following members.

Properties

  Name Description
Public property Name Gets or sets the name of the referenced Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public property Properties Represents a collection of Property objects. Each Property object represents a property defined on the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public property ProtocolProperties Represents a collection of ProtocolProperty objects. Each ProtocolProperty object represents an attribute defined on the referenced protocol.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address that represents the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter Updates any Protocol object property changes on an instance of SQL Server.
Protected method AlterProtocolProperties Updates any protocol object property changes on the Windows Management Instrumentation (WMI) installation. (Inherited from WmiSmoObject.)
Protected method CheckObjectState Checks the state of the referenced object. (Inherited from WmiSmoObject.)
Protected method CreateProtocolPropertyCollection Creates a set of protocol attributes for the referenced object. (Inherited from WmiSmoObject.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Protected method GetManagementObject Returns the object that manages the referenced protocol object.
Protected method GetPropertyManagementObject Gets the management object for the specified protocol property. (Inherited from WmiSmoObject.)
Protected method GetPropertyObject Gets the property from the specified collection with the specified position and value. (Inherited from WmiSmoObject.)
Protected method GetProtocolPropertyCollection Returns the protocol property collection for the referenced object. (Inherited from WmiSmoObject.)
Public method GetType (Inherited from Object.)
Protected method ImplInitialize Initializes the fields of the WmiSmoObjectobject. (Inherited from WmiSmoObject.)
Public method Initialize Initializes the referenced object. (Inherited from WmiSmoObject.)
Protected method InvokeMgmtMethod(ManagementObject, String, array<Object[]) Invokes the management method for the referenced object with the specified management object, method name, and parameters. (Inherited from WmiSmoObject.)
Protected method InvokeMgmtMethod(ManagementObject, ManagementOperationObserver, String, array<Object[]) Invokes the management method for the referenced object with the specified management object, observer, method name, and parameters. (Inherited from WmiSmoObject.)
Protected method IsObjectInitialized Specifies whether the referenced object is initialized. (Inherited from WmiSmoObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Refresh Refreshes the properties of the referenced object. (Overrides WmiSmoObject.Refresh().)
Protected method SetName Sets the name of the referenced object. (Inherited from WmiSmoObject.)
Protected method SetParentImpl Sets the parent of the referenced object. (Inherited from WmiSmoObject.)
Public method ToString (Inherited from Object.)
Protected method UpdateObjectState Updates the object state. (Inherited from WmiSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

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.

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.