Share via

DeliveryChannelArgument.Value Property

  • Article

Gets or sets the value of the delivery channel argument.

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

Syntax

'Declaration
Public Property Value As String

public string Value { get; set; }

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

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

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

public function get Value () : String

public function set Value (value : String)

Property Value

A String of up to 4000 characters that specifies the value of the delivery channel argument.

Remarks

The distributor passes argument names and values to the associated delivery protocol's Initialize method upon initialization.

Example

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

// Define a delivery channel for the custom protocol
DeliveryChannel customChannel = 
    new DeliveryChannel(myInstance, "MyCustomChannel");
customChannel.ProtocolName = "MyCustomProtocol";

// Define and add arguments for the custom delivery channel
DeliveryChannelArgument myArg1 = 
    new DeliveryChannelArgument(customChannel, "Arg1");
myArg1.Value = "Value1";
customChannel.DeliveryChannelArguments.Add(myArg1);

// Add the custom delivery channel to the instance
myInstance.DeliveryChannels.Add(customChannel);

' Define a delivery channel for the custom protocol
Dim customChannel As DeliveryChannel = _
    New DeliveryChannel(myInstance, "MyCustomChannel")
customChannel.ProtocolName = "MyCustomProtocol"

' Define and add arguments for the custom delivery channel
Dim myArg1 As DeliveryChannelArgument = _
    New DeliveryChannelArgument(customChannel, "Arg1")
myArg1.Value = "Value1"
customChannel.DeliveryChannelArguments.Add(myArg1)

' Add the custom delivery channel to the instance
myInstance.DeliveryChannels.Add(customChannel)

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

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

Other Resources

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