DeliveryChannel.ProtocolName Property

Gets or sets the name of the delivery protocol associated with the delivery channel.

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

Syntax

'Declaration
Public Property ProtocolName As String

public string ProtocolName { get; set; }

public:
property String^ ProtocolName {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_ProtocolName ()

/** @property */
public void set_ProtocolName (String value)

public function get ProtocolName () : String

public function set ProtocolName (value : String)

Property Value

A String of up to 64 characters containing the name of a standard or custom delivery protocol.

Remarks

The ProtocolName property links the delivery channel to a delivery protocol. The property value can be SMTP, File, or the name of a custom delivery protocol defined in using a ProtocolDefinition object.

Each delivery protocol can be associated with one or more delivery channels. The name of the specific delivery channel used to deliver a notification is defined in subscriber device records.

Example

The following examples show how to define a delivery channel for the standard file delivery protocol:

// Define a delivery channel that uses the built-in File protocol
DeliveryChannel fileChannel = 
    new DeliveryChannel(myInstance, "FileChannel");
fileChannel.ProtocolName = "File";

// Define and add arguments for the file delivery channel
DeliveryChannelArgument fileNameArg = 
    new DeliveryChannelArgument(fileChannel, "FileName");
fileNameArg.Value = sampleDirectory + 
    @"\Notifications\FileNotifications.txt";
fileChannel.DeliveryChannelArguments.Add(fileNameArg);

// Add the file delivery channel to the instance
myInstance.DeliveryChannels.Add(fileChannel);

' Define a delivery channel using the built-in File protocol
Dim fileChannel As DeliveryChannel = _
    New DeliveryChannel(myInstance, "FileChannel")
fileChannel.ProtocolName = "File"

' Define and add arguments for the file delivery channel
Dim fileNameArg As DeliveryChannelArgument = _
    New DeliveryChannelArgument(fileChannel, "FileName")
fileNameArg.Value = sampleDirectory + _
    "\Notifications\FileNotifications.txt"
fileChannel.DeliveryChannelArguments.Add(fileNameArg)

' Add the file delivery channel to the instance
myInstance.DeliveryChannels.Add(fileChannel)

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

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

See Also

Reference

DeliveryChannel Class
DeliveryChannel Members
Microsoft.SqlServer.Management.Nmo Namespace

Other Resources

Defining Delivery Channels
ProtocolName Element for DeliveryChannel (ICF)