ServCompMQTask.Initialize Method

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

Initializes the current ServCompMQTask.

Namespace:  Microsoft.SqlServer.Dts.Tasks.MessageQueueTask
Assembly:  Microsoft.SqlServer.MSMQTask (in Microsoft.SqlServer.MSMQTask.dll)

Syntax

'Declaration
Public Sub Initialize ( _
    desc As String, _
    dtFlOvrWrtable As Boolean, _
    MsgLngID As String, _
    MsgPkgID As String, _
    MsgVrsnID As String, _
    errIfMsgTmOt As Boolean, _
    quPath As String, _
    msmqConn As String, _
    rcvMsgTmOt As Long, _
    rcvMsgTp As MQMessageType, _
    rmvFromQu As Boolean, _
    saveDtFlNm As String, _
    strCmpTp As MQStringMessageCompare, _
    strCmpVal As String, _
    taskTp As MQType, _
    msgDtFl As String, _
    msgStr As String, _
    msgVars As String, _
    msgTp As MQMessageType, _
    useEncrp As Boolean, _
    encrpAlgthm As EncryptionAlgorithm, _
    use2000Fmt As Boolean, _
    otTask As MessageQueueTask _
)
'Usage
Dim instance As ServCompMQTask 
Dim desc As String 
Dim dtFlOvrWrtable As Boolean 
Dim MsgLngID As String 
Dim MsgPkgID As String 
Dim MsgVrsnID As String 
Dim errIfMsgTmOt As Boolean 
Dim quPath As String 
Dim msmqConn As String 
Dim rcvMsgTmOt As Long 
Dim rcvMsgTp As MQMessageType 
Dim rmvFromQu As Boolean 
Dim saveDtFlNm As String 
Dim strCmpTp As MQStringMessageCompare 
Dim strCmpVal As String 
Dim taskTp As MQType 
Dim msgDtFl As String 
Dim msgStr As String 
Dim msgVars As String 
Dim msgTp As MQMessageType 
Dim useEncrp As Boolean 
Dim encrpAlgthm As EncryptionAlgorithm 
Dim use2000Fmt As Boolean 
Dim otTask As MessageQueueTask

instance.Initialize(desc, dtFlOvrWrtable, _
    MsgLngID, MsgPkgID, MsgVrsnID, errIfMsgTmOt, _
    quPath, msmqConn, rcvMsgTmOt, rcvMsgTp, _
    rmvFromQu, saveDtFlNm, strCmpTp, _
    strCmpVal, taskTp, msgDtFl, msgStr, _
    msgVars, msgTp, useEncrp, encrpAlgthm, _
    use2000Fmt, otTask)

public void Initialize(
    string desc,
    bool dtFlOvrWrtable,
    string MsgLngID,
    string MsgPkgID,
    string MsgVrsnID,
    bool errIfMsgTmOt,
    string quPath,
    string msmqConn,
    long rcvMsgTmOt,
    MQMessageType rcvMsgTp,
    bool rmvFromQu,
    string saveDtFlNm,
    MQStringMessageCompare strCmpTp,
    string strCmpVal,
    MQType taskTp,
    string msgDtFl,
    string msgStr,
    string msgVars,
    MQMessageType msgTp,
    bool useEncrp,
    EncryptionAlgorithm encrpAlgthm,
    bool use2000Fmt,
    MessageQueueTask otTask
)

public:
void Initialize(
    String^ desc, 
    bool dtFlOvrWrtable, 
    String^ MsgLngID, 
    String^ MsgPkgID, 
    String^ MsgVrsnID, 
    bool errIfMsgTmOt, 
    String^ quPath, 
    String^ msmqConn, 
    long long rcvMsgTmOt, 
    MQMessageType rcvMsgTp, 
    bool rmvFromQu, 
    String^ saveDtFlNm, 
    MQStringMessageCompare strCmpTp, 
    String^ strCmpVal, 
    MQType taskTp, 
    String^ msgDtFl, 
    String^ msgStr, 
    String^ msgVars, 
    MQMessageType msgTp, 
    bool useEncrp, 
    EncryptionAlgorithm encrpAlgthm, 
    bool use2000Fmt, 
    MessageQueueTask^ otTask
)

member Initialize : 
        desc:string * 
        dtFlOvrWrtable:bool * 
        MsgLngID:string * 
        MsgPkgID:string * 
        MsgVrsnID:string * 
        errIfMsgTmOt:bool * 
        quPath:string * 
        msmqConn:string * 
        rcvMsgTmOt:int64 * 
        rcvMsgTp:MQMessageType * 
        rmvFromQu:bool * 
        saveDtFlNm:string * 
        strCmpTp:MQStringMessageCompare * 
        strCmpVal:string * 
        taskTp:MQType * 
        msgDtFl:string * 
        msgStr:string * 
        msgVars:string * 
        msgTp:MQMessageType * 
        useEncrp:bool * 
        encrpAlgthm:EncryptionAlgorithm * 
        use2000Fmt:bool * 
        otTask:MessageQueueTask -> unit

public function Initialize(
    desc : String, 
    dtFlOvrWrtable : boolean, 
    MsgLngID : String, 
    MsgPkgID : String, 
    MsgVrsnID : String, 
    errIfMsgTmOt : boolean, 
    quPath : String, 
    msmqConn : String, 
    rcvMsgTmOt : long, 
    rcvMsgTp : MQMessageType, 
    rmvFromQu : boolean, 
    saveDtFlNm : String, 
    strCmpTp : MQStringMessageCompare, 
    strCmpVal : String, 
    taskTp : MQType, 
    msgDtFl : String, 
    msgStr : String, 
    msgVars : String, 
    msgTp : MQMessageType, 
    useEncrp : boolean, 
    encrpAlgthm : EncryptionAlgorithm, 
    use2000Fmt : boolean, 
    otTask : MessageQueueTask
)

Parameters

• desc
  Type: System.String
  The description of the task.

• dtFlOvrWrtable
  Type: System.Boolean
  true to indicate that the data file message can overwrite an existing data file; otherwise, false.

• MsgLngID
  Type: System.String
  The identifier of the message lineage.

• MsgPkgID
  Type: System.String
  The identifier of the package that is the source of the message.

• MsgVrsnID
  Type: System.String
  The identifier of the message version.

• errIfMsgTmOt
  Type: System.Boolean
  true to indicate that the task fails when the message times out; otherwise, false.

• quPath
  Type: System.String
  The path of the queue.

• msmqConn
  Type: System.String
  The name of the connection for the MSMQ task.

• rcvMsgTmOt
  Type: System.Int64
  The number of seconds before a received message times out.

• rcvMsgTp
  Type: Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType
  The message type to receive.

• rmvFromQu
  Type: System.Boolean
  true to remove the message from the queue; otherwise, false.

• saveDtFlNm
  Type: System.String
  The name of the file to which an incoming Data File message is saved.

• strCmpTp
  Type: Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQStringMessageCompare
  The string comparison method to use.

• strCmpVal
  Type: System.String
  The String to which a string message is compared to when the TaskType is DTSMQType_Receiver.

• taskTp
  Type: Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQType
  The type of the task.

• msgDtFl
  Type: System.String
  The name of the data file used.

• msgStr
  Type: System.String
  A String that contains the message.

• msgVars
  Type: System.String
  The list of variables used in the message.

• msgTp
  Type: Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MQMessageType
  The type of message to send.

• useEncrp
  Type: System.Boolean
  true to use encryption; otherwise, false.

• encrpAlgthm
  Type: System.Messaging.EncryptionAlgorithm
  The name of the encryption algorithm to use.

• use2000Fmt
  Type: System.Boolean
  true to use the SQL Server 2000 format; otherwise, false.

• otTask
  Type: Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask
  The specified Message Queue task.

See Also

Reference

ServCompMQTask Class

Microsoft.SqlServer.Dts.Tasks.MessageQueueTask Namespace