Share via

  • Article

MessageQueueTask.StringMessageToVariableName Property

Gets or sets the name of the variable to which the message contents are saved.

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

Syntax

'Declaration
Public Property StringMessageToVariableName As String
    Get
    Set
'Usage
Dim instance As MessageQueueTask
Dim value As String

value = instance.StringMessageToVariableName

instance.StringMessageToVariableName = value

public string StringMessageToVariableName { get; set; }

public:
virtual property String^ StringMessageToVariableName {
    String^ get () sealed;
    void set (String^ value) sealed;
}

abstract StringMessageToVariableName : string with get, set
override StringMessageToVariableName : string with get, set

final function get StringMessageToVariableName () : String
final function set StringMessageToVariableName (value : String)

Property Value

Type: System.String
A String that contains the variable to store the message in.

Implements

IMessageQueueTask.StringMessageToVariableName

Remarks

This method is used only when the MSMQ task is receiving mail. The contents of the message are stored in a variable.

Examples

The following code example adds a variable to the package, and specifies that the variable be used for storing the message contents.

myPackage.Variables.Add("ReceiveMessageVariable", false, "", "empty");
myMSMQTask.StringMessageToVariableName = "ReceiveMessageVariable";