MSMQConn Class

Definition

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

public ref class MSMQConn : Microsoft::SqlServer::Dts::Runtime::ConnectionManagerBase, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist
[Microsoft.SqlServer.Dts.Runtime.DtsConnection(ConnectionContact="Microsoft Corporation", ConnectionType="MSMQ", LocalizationType=typeof(Microsoft.SqlServer.Dts.ManagedConnections.MSMQConn), UITypeName="Microsoft.DataTransformationServices.Design.MsmqConnectionManagerUI, Microsoft.DataTransformationServices.Design, Version=13.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")]
public class MSMQConn : Microsoft.SqlServer.Dts.Runtime.ConnectionManagerBase, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist
[Microsoft.SqlServer.Dts.Runtime.DtsConnection(ConnectionContact="Microsoft Corporation", ConnectionType="MSMQ", LocalizationType=typeof(Microsoft.SqlServer.Dts.ManagedConnections.MSMQConn), UITypeName="Microsoft.DataTransformationServices.Design.MsmqConnectionManagerUI, Microsoft.DataTransformationServices.Design, Version=14.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")]
public class MSMQConn : Microsoft.SqlServer.Dts.Runtime.ConnectionManagerBase, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist
[Microsoft.SqlServer.Dts.Runtime.DtsConnection(ConnectionContact="Microsoft Corporation", ConnectionType="MSMQ", LocalizationType=typeof(Microsoft.SqlServer.Dts.ManagedConnections.MSMQConn), UITypeName="Microsoft.DataTransformationServices.Design.MsmqConnectionManagerUI, Microsoft.DataTransformationServices.Design, Version=15.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")]
public class MSMQConn : Microsoft.SqlServer.Dts.Runtime.ConnectionManagerBase, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist
[<Microsoft.SqlServer.Dts.Runtime.DtsConnection(ConnectionContact="Microsoft Corporation", ConnectionType="MSMQ", LocalizationType=typeof(Microsoft.SqlServer.Dts.ManagedConnections.MSMQConn), UITypeName="Microsoft.DataTransformationServices.Design.MsmqConnectionManagerUI, Microsoft.DataTransformationServices.Design, Version=13.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")>]
type MSMQConn = class
    inherit ConnectionManagerBase
    interface IDTSComponentPersist
[<Microsoft.SqlServer.Dts.Runtime.DtsConnection(ConnectionContact="Microsoft Corporation", ConnectionType="MSMQ", LocalizationType=typeof(Microsoft.SqlServer.Dts.ManagedConnections.MSMQConn), UITypeName="Microsoft.DataTransformationServices.Design.MsmqConnectionManagerUI, Microsoft.DataTransformationServices.Design, Version=14.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")>]
type MSMQConn = class
    inherit ConnectionManagerBase
    interface IDTSComponentPersist
[<Microsoft.SqlServer.Dts.Runtime.DtsConnection(ConnectionContact="Microsoft Corporation", ConnectionType="MSMQ", LocalizationType=typeof(Microsoft.SqlServer.Dts.ManagedConnections.MSMQConn), UITypeName="Microsoft.DataTransformationServices.Design.MsmqConnectionManagerUI, Microsoft.DataTransformationServices.Design, Version=15.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")>]
type MSMQConn = class
    inherit ConnectionManagerBase
    interface IDTSComponentPersist
Public Class MSMQConn
Inherits ConnectionManagerBase
Implements IDTSComponentPersist
Inheritance
Attributes
Implements

Constructors

MSMQConn()

Initializes a new instance of the MSMQConn class.

MSMQConn(String)

Initializes a new instance of the MSMQConn class, and initializes the path to the message queue.

Properties

AccessTokenProvider

Gets or sets the access token provider used when acquiring connection.

(Inherited from ConnectionManagerBase)
ConnectionDescription

Returns the localized description of the connection.

ConnectionDisplayName

Returns the localized display name of the connection.

ConnectionString

Gets or sets the connection string for the MSMQ connection.

Path

Gets or sets the path to the files.

ProtectionLevel

Gets or sets a value, by using the DTSProtectionLevel enumeration, that enforces how the connection controls sensitive information.

(Inherited from ConnectionManagerBase)
Scope

Gets the DTS connection manager scope for this ConnectionManagerBase object.

(Inherited from ConnectionManagerBase)
SupportsDTCTransactions

Returns a Boolean that indicates if the connection supports Microsoft Distributed Transaction Coordinator (MS DTC) transactions.

(Inherited from ConnectionManagerBase)
TargetServerVersion (Inherited from ConnectionManagerBase)
Version

Returns the version of this connection manager.

(Inherited from ConnectionManagerBase)

Methods

AcquireConnection(Object)

Establishes the MSMQ connection and returns a connection object.

CanUpdate(String)

Gets or sets a Boolean that determines whether a connection manager supports upgrading the connection XML to a newer version.

(Inherited from ConnectionManagerBase)
Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
LoadFromXML(XmlElement, IDTSInfoEvents)

This method is not callable by your application code. To load a package that is saved as .xml to the hard drive, use the LoadPackage(String, IDTSEvents) method.

ReleaseConnection(Object)

Frees the connection established during AcquireConnection(Object). Called at design time and run time.

(Inherited from ConnectionManagerBase)
SaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.

SetQualifier(String)

Changes a qualifier on the connection manager after the connection manager has been created, but before it is run.

(Inherited from ConnectionManagerBase)
Update(String)

Updates the XML persisted by a previous version of the connection manager.

(Inherited from ConnectionManagerBase)
Validate(IDTSInfoEvents)

Validates the connection and returns an enumeration that indicates success or failure.

(Inherited from ConnectionManagerBase)

Applies to