Share via


MSMQConn Class

Contains the methods and properties used by MSMQ connections. It has been defined with the DtsConnection attribute, DtsConnectionAttribute.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.ConnectionManagerBase
      Microsoft.SqlServer.Dts.ManagedConnections.MSMQConn

Namespace:  Microsoft.SqlServer.Dts.ManagedConnections
Assembly:  Microsoft.SqlServer.ManagedConnections (in Microsoft.SqlServer.ManagedConnections.dll)

Syntax

'Declaration
<DtsConnectionAttribute(LocalizationType := GetType(MSMQConn), ConnectionType := "MSMQ",  _
    ConnectionContact := "Microsoft Corporation", UITypeName := "Microsoft.DataTransformationServices.Design.MsmqConnectionManagerUI, Microsoft.DataTransformationServices.Design, Version=11.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")> _
Public Class MSMQConn _
    Inherits ConnectionManagerBase _
    Implements IDTSComponentPersist
'Usage
Dim instance As MSMQConn
[DtsConnectionAttribute(LocalizationType = typeof(MSMQConn), ConnectionType = "MSMQ", 
    ConnectionContact = "Microsoft Corporation", UITypeName = "Microsoft.DataTransformationServices.Design.MsmqConnectionManagerUI, Microsoft.DataTransformationServices.Design, Version=11.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")]
public class MSMQConn : ConnectionManagerBase, IDTSComponentPersist
[DtsConnectionAttribute(LocalizationType = typeof(MSMQConn), ConnectionType = L"MSMQ", 
    ConnectionContact = L"Microsoft Corporation", UITypeName = L"Microsoft.DataTransformationServices.Design.MsmqConnectionManagerUI, Microsoft.DataTransformationServices.Design, Version=11.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")]
public ref class MSMQConn : public ConnectionManagerBase, 
    IDTSComponentPersist
[<DtsConnectionAttribute(LocalizationType = typeof(MSMQConn), ConnectionType = "MSMQ", 
    ConnectionContact = "Microsoft Corporation", UITypeName = "Microsoft.DataTransformationServices.Design.MsmqConnectionManagerUI, Microsoft.DataTransformationServices.Design, Version=11.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")>]
type MSMQConn =  
    class 
        inherit ConnectionManagerBase 
        interface IDTSComponentPersist 
    end
public class MSMQConn extends ConnectionManagerBase implements IDTSComponentPersist

The MSMQConn type exposes the following members.

Constructors

  Name Description
Public method MSMQConn() Initializes a new instance of the MSMQConn class.
Public method MSMQConn(String) Initializes a new instance of the MSMQConn class, and initializes the path to the message queue.

Top

Properties

  Name Description
Public propertyStatic member ConnectionDescription Returns the localized description of the connection.
Public propertyStatic member ConnectionDisplayName Returns the localized display name of the connection.
Public property ConnectionString Gets or sets the connection string for the MSMQ connection. (Overrides ConnectionManagerBase.ConnectionString.)
Public property Path Gets or sets the path to the files.
Public property ProtectionLevel Gets or sets a value, by using the DTSProtectionLevel enumeration, that enforces how the connection controls sensitive information. (Inherited from ConnectionManagerBase.)
Public property Scope Gets the DTS connection manager scope for this ConnectionManagerBase object. (Inherited from ConnectionManagerBase.)
Public property SupportsDTCTransactions Returns a Boolean that indicates if the connection supports Microsoft Distributed Transaction Coordinator (MS DTC) transactions. (Inherited from ConnectionManagerBase.)
Public property Version Returns the version of this connection manager. (Inherited from ConnectionManagerBase.)

Top

Methods

  Name Description
Public method AcquireConnection Establishes the MSMQ connection and returns a connection object. (Overrides ConnectionManagerBase.AcquireConnection(Object).)
Public method CanUpdate Gets or sets a Boolean that determines whether a connection manager supports upgrading the connection XML to a newer version. (Inherited from ConnectionManagerBase.)
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType (Inherited from Object.)
Public method LoadFromXML This method is not callable by your application code. To load a package that is saved as .xml to the hard drive, use the Application.LoadPackage method.
Protected method MemberwiseClone (Inherited from Object.)
Public method ReleaseConnection Frees the connection established during AcquireConnection. Called at design time and run time. (Inherited from ConnectionManagerBase.)
Public method SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public method SetQualifier Changes a qualifier on the connection manager after the connection manager has been created, but before it is run. (Inherited from ConnectionManagerBase.)
Public method ToString (Inherited from Object.)
Public method Update Updates the XML persisted by a previous version of the connection manager. (Inherited from ConnectionManagerBase.)
Public method Validate Validates the connection and returns an enumeration that indicates success or failure. (Inherited from ConnectionManagerBase.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Dts.ManagedConnections Namespace