SubscriptionFieldCollection.Add Method (SubscriptionField, String)

Adds a SubscriptionField before another SubscriptionField in the SubscriptionFieldCollection object.

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

Syntax

'Declaration
Public Sub Add ( _
    subscriptionField As SubscriptionField, _
    insertAtColumnName As String _
)

public void Add (
    SubscriptionField subscriptionField,
    string insertAtColumnName
)

public:
void Add (
    SubscriptionField^ subscriptionField, 
    String^ insertAtColumnName
)

public void Add (
    SubscriptionField subscriptionField, 
    String insertAtColumnName
)

public function Add (
    subscriptionField : SubscriptionField, 
    insertAtColumnName : String
)

Parameters

• subscriptionField
  The SubscriptionField to add to the collection.

• insertAtColumnName
  A String value that specifies the name of the subscription field before which to insert the new SubscriptionField object.

Remarks

This method allows you to insert a subscription field at a specific position in the subscription field list. Each subscription field becomes a column in a table. Depending on how you add subscriptions, the order of the columns can be important.

If you add a subscription field, updating the instance re-creates the subscription class to which it corresponds. Notification Services renames the existing subscription tables by appending "Old" to the table name and then creates new tables. Existing subscription table indexes are left unchanged.

Use the Update method to update the instance.

If you want to transfer data between the old and new subscription tables, it must be done manually. For more information, see Updating an Application.

Example

The following examples show how to define a subscription field and add it before the GoingTo field in the collection of subscription fields:

// Define a LeavingFrom field and add it before the GoingTo field
SubscriptionField subOrgin = 
    new SubscriptionField(flightSubscriptions, "LeavingFrom");
subOrgin.Type = "nvarchar(6)";
flightSubscriptions.SubscriptionFields.Add(subOrgin, "GoingTo");

' Define a LeavingFrom field and add it before the GoingTo field
Dim subOrgin As SubscriptionField = _
    New SubscriptionField(flightSubscriptions, "LeavingFrom")
subOrgin.Type = "nvarchar(6)"
flightSubscriptions.SubscriptionFields.Add(subOrgin, "GoingTo")

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

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

Other Resources

Defining the Subscription Schema
Field Element for Schema/Fields (ADF)