Share via

DeliveryChannelArgument Constructor (DeliveryChannel, String)

  • Article

Initializes a new instance of the DeliveryChannelArgument class with a DeliveryChannel object and a name.

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

Syntax

'Declaration
Public Sub New ( _
    deliveryChannel As DeliveryChannel, _
    name As String _
)

public DeliveryChannelArgument (
    DeliveryChannel deliveryChannel,
    string name
)

public:
DeliveryChannelArgument (
    DeliveryChannel^ deliveryChannel, 
    String^ name
)

public DeliveryChannelArgument (
    DeliveryChannel deliveryChannel, 
    String name
)

public function DeliveryChannelArgument (
    deliveryChannel : DeliveryChannel, 
    name : String
)

Parameters

  • name
    A String of up to 255 characters specifying the argument name.

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

Remarks

Delivery channel arguments are dependent on the delivery protocol. Each protocol has its own requirements. For information about the arguments required by standard delivery protocols, see Standard Delivery Protocols.

Example

The following examples show how to define a file delivery channel and its arguments:

// 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)

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

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

Other Resources

Defining Delivery Channels
Name Element for DeliveryChannel/Arguments/Argument (ICF)