ProtocolDefinitionCollection.Add Method

Article
12/03/2008

Adds a ProtocolDefinition to the ProtocolDefinitionCollection.

Namespace: Microsoft.SqlServer.Management.Nmo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Sub Add ( _
    protocolDefinition As ProtocolDefinition _
)

public void Add (
    ProtocolDefinition protocolDefinition
)

public:
void Add (
    ProtocolDefinition^ protocolDefinition
)

public void Add (
    ProtocolDefinition protocolDefinition
)

public function Add (
    protocolDefinition : ProtocolDefinition
)

Parameters

protocolDefinition
The ProtocolDefinition to add to the collection.

Remarks

Each ProtocolDefinition in the collection must have a unique name.

If you add a ProtocolDefinition after deploying the instance, you must Update the instance to apply the changes.

Example

The following examples show how to declare a custom delivery protocol and add it to the collection of custom delivery protocols for an instance of Notification Services:

ProtocolDefinition customProtocol = 
    new ProtocolDefinition(myInstance, "MyCustomProtocol");
customProtocol.ClassName = "MyNamespace.MyProtocolClass";
customProtocol.AssemblyName = @"C:\NS\Full\MyCustomComponents.dll";
myInstance.ProtocolDefinitions.Add(customProtocol);

Dim customProtocol As ProtocolDefinition = _
    New ProtocolDefinition(myInstance, "MyCustomProtocol")
customProtocol.ClassName = "MyNamespace.MyProtocolClass"
customProtocol.AssemblyName = _
    "C:\NS\Full\MyCustomComponents.dll"
myInstance.ProtocolDefinitions.Add(customProtocol)

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms