ProtocolField.FieldReference Property

  • Article

Gets or sets a reference to a notification field for use in the protocol header.

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

Syntax

'Declaration
Public Property FieldReference As String

public string FieldReference { get; set; }

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

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

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

public function get FieldReference () : String

public function set FieldReference (value : String)

Property Value

A String, between 1 and 128 characters in length, that specifies the name of a notification field.

Remarks

The FieldReference value can be any notification field or computed field defined for the notification class or any of the following built-in fields: DeliveryChannelName, SubscriberId, DeviceName, DeviceTypeName, DeviceAddress, SubscriberLocale.

If the ProtocolField does not use a FieldReference property it must use a SqlExpression property instead.

Example

The following examples show how to define a protocol field that references a notification class field:

ProtocolField fileProtocolField1 = 
    new ProtocolField(fileProtocol, "LeavingFrom");
fileProtocolField1.FieldReference = "LeavingFrom";
fileProtocol.ProtocolFields.Add(fileProtocolField1);

Dim fileProtocolField1 As ProtocolField = _
    New ProtocolField(fileProtocol, "LeavingFrom")
fileProtocolField1.FieldReference = "LeavingFrom"
fileProtocol.ProtocolFields.Add(fileProtocolField1)

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

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

Other Resources

FieldReference Element (ADF)
Specifying the Delivery Protocol Name and Fields