ProtocolDefinition Constructor (Instance, String)

Artikel
12/15/2008

Initializes a new instance of the ProtocolDefinition class with a parent Instance object and a name.

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

Syntax

'Declaration
Public Sub New ( _
    instance As Instance, _
    name As String _
)

public ProtocolDefinition (
    Instance instance,
    string name
)

public:
ProtocolDefinition (
    Instance^ instance, 
    String^ name
)

public ProtocolDefinition (
    Instance instance, 
    String name
)

public function ProtocolDefinition (
    instance : Instance, 
    name : String
)

Parameter

instance
The parent Instance for the protocol definition.

name
A String, between 1 and 64 characters in length, that specifies the name of the protocol.

You cannot change the name. To rename a protocol, you must remove the protocol and then add a protocol that has the new name.

Hinweise

The name value must be unique within the instance of Notification Services. It cannot be Simple Mail Transfer Protocol (SMTP) or File, which are standard delivery protocols for all instances of Notification Services.

Protocol names cannot contain the following characters: open bracket ([), close bracket (]), quotation mark ("), single quote ('), backslash (\), and forward slash (/).

Beispiel

The following examples show how to declare a custom delivery protocol and add it to 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)