MessageQueueTask.StringMessageToVariableName Property

Article
12/03/2008

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

public string StringMessageToVariableName { get; set; }

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

/** @property */
public final String get_StringMessageToVariableName ()

/** @property */
public final void set_StringMessageToVariableName (String value)

public final function get StringMessageToVariableName () : String

public final function set StringMessageToVariableName (value : String)

Property Value

A String that contains the variable to store the message in.

Remarks

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

Example

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";

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