Instance.ProtocolDefinitions Property

  • Article

Gets the collection of custom delivery protocols for the instance of Notification Services.

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

Syntax

'Declaration
Public ReadOnly Property ProtocolDefinitions As ProtocolDefinitionCollection

public ProtocolDefinitionCollection ProtocolDefinitions { get; }

public:
property ProtocolDefinitionCollection^ ProtocolDefinitions {
    ProtocolDefinitionCollection^ get ();
}

/** @property */
public ProtocolDefinitionCollection get_ProtocolDefinitions ()

public function get ProtocolDefinitions () : ProtocolDefinitionCollection

Property Value

The ProtocolDefinitionCollection for the Instance.

Remarks

You only need to define custom delivery protocols, not the built-in Simple Mail Transfer Protocol (SMTP) and File delivery protocols. Use the ProtocolDefinition class to define individual custom delivery protocols. Use the methods of the ProtocolDefinitionCollection class to add, remove, or get individual ProtocolDefinition objects.

If you use this property to enumerate delivery protocols for a Notification Services instance, only custom delivery protocols are returned. The built-in File and SMTP delivery protocols are not returned.

Example

The following examples show how to declare a custom delivery protocol for use with your Notification Services instance:

ProtocolDefinition customProtocol = 
    new ProtocolDefinition(myInstance, "MyCustomProtocol");
customProtocol.ClassName = "MyNamespace.MyProtocolClass";
customProtocol.AssemblyName = @"C:\NS\Full\MyCustomComponents.dll";
myInstance.ProtocolDefinitions.Add(customProtocol);

Dim customProtocol As ProtocolDefinition = _
    New ProtocolDefinition(myInstance, "MyCustomProtocol")
customProtocol.ClassName = "MyNamespace.MyProtocolClass"
customProtocol.AssemblyName = _
    "C:\NS\Full\MyCustomComponents.dll"
myInstance.ProtocolDefinitions.Add(customProtocol)

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

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

Other Resources

Configuring Instances of Notification Services
Protocols Element (ICF)