ProtocolDefinition.Parent Property

  • Article

Gets or sets the parent Instance for the protocol definition.

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

Syntax

'Declaration
Public Property Parent As Instance

public Instance Parent { get; set; }

public:
property Instance^ Parent {
    Instance^ get ();
    void set (Instance^ value);
}

/** @property */
public Instance get_Parent ()

/** @property */
public void set_Parent (Instance value)

public function get Parent () : Instance

public function set Parent (value : Instance)

Property Value

The parent Instance object.

Remarks

Updated text:5 December 2005

Updated sample code:5 December 2005

If you set the parent in the constructor, do not set the parent using this property. Setting the parent twice throws an exception.

If you use the default constructor, you must set this property and the Name property before you can set other properties.

Example

The following examples show how to set the Parent property when using the default constructor:

// Define a custom delivery protocol and set required properties.
ProtocolDefinition customProtocol = new ProtocolDefinition();
customProtocol.Name = "MyCustomProtocol";
customProtocol.Parent = myInstance;
customProtocol.ClassName = "MyNamespace.MyProtocolClass";
customProtocol.AssemblyName = @"C:\NS\Default\MyCustomComponents.dll";
myInstance.ProtocolDefinitions.Add(customProtocol);

' Define a custom delivery protocol and set required properties.
Dim customProtocol As ProtocolDefinition = _
    New ProtocolDefinition()
customProtocol.Name = "MyCustomProtocol"
customProtocol.Parent = myInstance
customProtocol.ClassName = "MyNamespace.MyProtocolClass"
customProtocol.AssemblyName = "C:\NS\Default\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

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

Other Resources

Defining Custom Delivery Protocols
NotificationServicesInstance Element (ICF)