ProtocolFieldCollection.Add Method (ProtocolField, Int32)

Artikkeli
12/03/2008

Adds a ProtocolField object to the ProtocolFieldCollection object at the specified location.

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

Syntax

'Declaration
Public Sub Add ( _
    protocolField As ProtocolField, _
    insertAtPosition As Integer _
)

public void Add (
    ProtocolField protocolField,
    int insertAtPosition
)

public:
void Add (
    ProtocolField^ protocolField, 
    int insertAtPosition
)

public void Add (
    ProtocolField protocolField, 
    int insertAtPosition
)

public function Add (
    protocolField : ProtocolField, 
    insertAtPosition : int
)

Parameters

protocolField
The ProtocolField object to add to the collection.

insertAtPosition
A Int32 that specifies the zero-based position in the collection where you want to add the ProtocolField object.

Remarks

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

The protocol field currently at the position, and all subsequent protocol fields, are moved down the list.

If you add a protocol field to a deployed application, updating the instance deletes and re-creates the notification class to which it corresponds. This includes dropping and re-creating the tables used by the notification class. Any data existing in the existing notification class tables is permanently deleted.

Example

The following example shows how to add a protocol field at the second position in a collection of protocol fields:

ProtocolField fileProtocolField3 = 
    new ProtocolField(fileProtocol, "Price");
fileProtocolField3.FieldReference = "FormattedPrice";
fileProtocol.ProtocolFields.Add(fileProtocolField3, 1);

Dim fileProtocolField3 As ProtocolField = _
    New ProtocolField(fileProtocol, "Price")
fileProtocolField3.FieldReference = "FormattedPrice"
fileProtocol.ProtocolFields.Add(fileProtocolField3, 1)

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