Share via


MSMQMessage.Trace (Compact 2013)

3/26/2014

The property specifies how Message Queuing traces the route of the message.

Syntax

HRESULT get_Trace( 
  long* plTrace 
);
HRESULT put_Trace( 
  long lTrace
);

Parameters

  • plTrace or lTrace
    Value that specifies how Message Queuing traces the route of the message. The following table shows the possible values.

    Value

    Description

    MQMSG_SEND_ROUTE_TO_REPORT_QUEUE

    Tracing is requested. Each hop made by the original message generates a report message that is sent to a report queue.

    MQMSG_TRACE_NONE

    The default. Tracing is not requested.

Return Value

The following table describes the common return values.

Value

Description

S_OK

Success

E_INVALIDARG

One or more arguments are invalid

E_NOTIMPL

The function contains no implementation

E_OUTOFMEMORY

Out of memory

Remarks

When tracing is enabled and a report queue is specified, report messages are created and sent to the report queue each time the message leaves or arrives at a Message Queuing computer.

For example, report messages are generated at the following times:

  • When the message leaves the source computer, one report message is generated.
  • When the message arrives at and leaves a routing server, two report messages are generated.
  • When the message arrives the target computer where the destination queue resides, one report message is generated.

Report queues are specified by the computer. If MQMSG_SEND_ROUTE_TO_REPORT_QUEUE is specified but the report queue is not specified, this property is ignored.

Message Queuing does not support tracing under the following conditions.

  • When you send messages to multiple destinations using distribution lists, multicast addresses, and multiple-element format names.
  • When you send HTTP messages.

Equivalent Function property

When using functions, you can set the tracing level of the message using the PROPID_M_TRACE property.

Requirements

Header

mqoai.h

Library

mqoa.lib

See Also

Reference

MSMQMessage
PROPID_M_TRACE