MessagePropertyFilter.UseTracing Property

Definition

Gets or sets a value that indicates whether to retrieve UseTracing property information when receiving or peeking a message.

public:
 property bool UseTracing { bool get(); void set(bool value); };
[System.Messaging.MessagingDescription("MsgUseTracing")]
public bool UseTracing { get; set; }
[<System.Messaging.MessagingDescription("MsgUseTracing")>]
member this.UseTracing : bool with get, set
Public Property UseTracing As Boolean

Property Value

true to receive UseTracing information; otherwise, false. The default is false.

Attributes

Examples

The following code example demonstrates the use of the UseTracing property.

// Set the queue's MessageReadPropertyFilter property 
// to enable the message's UseTracing property.
queue->MessageReadPropertyFilter->UseTracing = true;

// Peek at the message. Time out after ten seconds 
// in case the message was not delivered.
orderMessage = queue->Peek(TimeSpan::FromSeconds(10.0));

// Display the value of the message's 
// UseTracing property.
Console::WriteLine("Message.UseTracing: {0}", 
    orderMessage->UseTracing);
// Set the queue's MessageReadPropertyFilter property to enable the
// message's UseTracing property.
queue.MessageReadPropertyFilter.UseTracing = true;

// Peek at the message. Time out after ten seconds in case the message
// was not delivered.
orderMessage = queue.Peek(TimeSpan.FromSeconds(10.0));

// Display the value of the message's UseTracing property.
Console.WriteLine("Message.UseTracing: {0}",
    orderMessage.UseTracing);

Remarks

The UseTracing property of the Message class specifies whether to track the route of a message as it moves toward its destination queue. If true, each time the original message passes through a Message Queuing routing server, a Message Queuing-generated report message is sent to the system report queue.

Using tracing involves setting up Active Directory and specifying a report queue for the Message Queuing enterprise. These settings are configured by the administrator.

Applies to

See also