Partilhar via

ProtocolFieldCollection.Add Method (ProtocolField, String)

  • Artigo

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

Syntax

'Declaration
Public Sub Add ( _
    protocolField As ProtocolField, _
    insertAtColumnName As String _
)

public void Add (
    ProtocolField protocolField,
    string insertAtColumnName
)

public:
void Add (
    ProtocolField^ protocolField, 
    String^ insertAtColumnName
)

public void Add (
    ProtocolField protocolField, 
    String insertAtColumnName
)

public function Add (
    protocolField : ProtocolField, 
    insertAtColumnName : String
)

Parameters

  • protocolField
    The ProtocolField object to add to the collection.
  • insertAtColumnName
    A String value that specifies the name of a protocol field before which to add the new 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.

If you add a 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 before the Price field in the collection of protocol fields:

ProtocolField fileProtocolField2 = 
    new ProtocolField(fileProtocol, "GoingTo");
fileProtocolField2.FieldReference = "GoingTo";
fileProtocol.ProtocolFields.Add(fileProtocolField2, "Price");

Dim fileProtocolField2 As ProtocolField = _
    New ProtocolField(fileProtocol, "GoingTo")
fileProtocolField2.FieldReference = "GoingTo"
fileProtocol.ProtocolFields.Add(fileProtocolField2, "Price")

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

ProtocolFieldCollection Class
ProtocolFieldCollection Members
Microsoft.SqlServer.Management.Nmo Namespace
Instance.Update Method

Other Resources

Configuring Delivery Protocols
Field Element for Protocol/Fields (ADF)