DeliveryChannel.DeliveryChannelArguments Property

Gets the collection of delivery channel arguments for the delivery channel.

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

Syntax

'Declaration
Public ReadOnly Property DeliveryChannelArguments As DeliveryChannelArgumentCollection

public DeliveryChannelArgumentCollection DeliveryChannelArguments { get; }

public:
property DeliveryChannelArgumentCollection^ DeliveryChannelArguments {
    DeliveryChannelArgumentCollection^ get ();
}

/** @property */
public DeliveryChannelArgumentCollection get_DeliveryChannelArguments ()

public function get DeliveryChannelArguments () : DeliveryChannelArgumentCollection

Property Value

A DeliveryChannelArgumentCollection object containing the arguments for the delivery channel.

Remarks

Use the DeliveryChannelArgumentCollection and DeliveryChannelArgument objects to define the arguments for a delivery channel.

Delivery channel arguments supply information used to connect to or deliver notifications to a specific delivery channel. For examples of delivery channel arguments, see Defining a File Delivery Channel and Defining an SMTP Delivery Channel.

Example

The following examples show how to define a 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)

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
Arguments Element (ICF)