Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

509 lines
26 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="MsmqIntegrationMessageProperty" FullName="System.ServiceModel.MsmqIntegration.MsmqIntegrationMessageProperty">
<TypeSignature Language="C#" Value="public sealed class MsmqIntegrationMessageProperty" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit MsmqIntegrationMessageProperty extends System.Object" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.ServiceModel.MsmqIntegration.MsmqIntegrationMessageProperty" /> class exposes all of the Message Queuing message properties that you can set when you send a message or read a message that has been received using the integration channel.</para>
<para>The <see cref="T:System.ServiceModel.MsmqIntegration.MsmqMessage`1" /> class also enables you to set Message Queuing message properties, and is the recommended way to set Message Queuing message properties.</para>
<para>When you use the channels and messages infrastructure to create a message and send it over an integration channel, you can use the <see cref="T:System.ServiceModel.MsmqIntegration.MsmqIntegrationMessageProperty" /> class as a property of the message so that the integration channel can retrieve the message properties and format the message as a Message Queuing message and send it on the wire.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents the Message Queuing (MSMQ) integration properties for a message.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MsmqIntegrationMessageProperty ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.MsmqIntegration.MsmqIntegrationMessageProperty" /> class. </para>
</summary>
</Docs>
</Member>
<Member MemberName="AcknowledgeType">
<MemberSignature Language="C#" Value="public Nullable&lt;System.Messaging.AcknowledgeTypes&gt; AcknowledgeType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.Messaging.AcknowledgeTypes&gt; AcknowledgeType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable&lt;System.Messaging.AcknowledgeTypes&gt;</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the acknowledgment type to return to the sending application.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Acknowledgment">
<MemberSignature Language="C#" Value="public Nullable&lt;System.Messaging.Acknowledgment&gt; Acknowledgment { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.Messaging.Acknowledgment&gt; Acknowledgment" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable&lt;System.Messaging.Acknowledgment&gt;</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Possible values that this property can be set to are defined by <see cref="T:System.Messaging.Acknowledgment" />. The value can be used to verify the status of the original message when you receive a message from an administration queue.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the acknowledgment message that Message Queuing (MSMQ) generates.</para>
</summary>
</Docs>
</Member>
<Member MemberName="AdministrationQueue">
<MemberSignature Language="C#" Value="public Uri AdministrationQueue { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri AdministrationQueue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The acknowledgment messages sent to the administration queue can indicate whether the original message reached its destination queue and whether it was removed from the queue.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the queue that receives the acknowledgment messages that Message Queuing (MSMQ) generates.</para>
</summary>
</Docs>
</Member>
<Member MemberName="AppSpecific">
<MemberSignature Language="C#" Value="public Nullable&lt;int&gt; AppSpecific { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; AppSpecific" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Contains application-specific information that you can use to organize different types of messages. For example, you can use application-specific indexes.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies additional application-specific information.</para>
</summary>
</Docs>
</Member>
<Member MemberName="ArrivedTime">
<MemberSignature Language="C#" Value="public Nullable&lt;DateTime&gt; ArrivedTime { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.DateTime&gt; ArrivedTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable&lt;System.DateTime&gt;</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the time that the message arrived in the destination queue.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Authenticated">
<MemberSignature Language="C#" Value="public Nullable&lt;bool&gt; Authenticated { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; Authenticated" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates whether the message was authenticated.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets whether the message was authenticated.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Body">
<MemberSignature Language="C#" Value="public object Body { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Body" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the content of the message.</para>
</summary>
</Docs>
</Member>
<Member MemberName="BodyType">
<MemberSignature Language="C#" Value="public Nullable&lt;int&gt; BodyType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; BodyType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Message Queuing (MSMQ) recognizes the body contents as an object or as a serialized stream. The body type indicates the type of the object within the body of the message.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the type of data that the message body contains.</para>
</summary>
</Docs>
</Member>
<Member MemberName="CorrelationId">
<MemberSignature Language="C#" Value="public string CorrelationId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CorrelationId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When Message Queuing (MSMQ) generates an acknowledgment or report message, it uses the correlation identifier to specify the message identifier of the original message. In this manner, the correlation identifier ties the report or acknowledgment message to the original message.</para>
<para>The sending application can then match the acknowledgment or report with the original message by using the correlation identifier to verify the original message's identity.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the message identifier used by acknowledgment, report, and response messages to reference the original message.</para>
</summary>
</Docs>
</Member>
<Member MemberName="DestinationQueue">
<MemberSignature Language="C#" Value="public Uri DestinationQueue { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri DestinationQueue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Most commonly used to determine the original destination of a message that arrived in a journal or dead-letter queue.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the intended destination queue for the message.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Extension">
<MemberSignature Language="C#" Value="public byte[] Extension { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int8[] Extension" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides for application-defined information, such as a large binary object, that is associated with the message.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets additional, application-defined information associated with the message.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public static System.ServiceModel.MsmqIntegration.MsmqIntegrationMessageProperty Get (System.ServiceModel.Channels.Message message);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.ServiceModel.MsmqIntegration.MsmqIntegrationMessageProperty Get(class System.ServiceModel.Channels.Message message) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.MsmqIntegration.MsmqIntegrationMessageProperty</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.ServiceModel.Channels.Message" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the <see cref="T:System.ServiceModel.MsmqIntegration.MsmqIntegrationMessageProperty" /> for a given message.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.ServiceModel.MsmqIntegration.MsmqIntegrationMessageProperty" /> object that contains the Message Queuing integration properties for the specified message.</para>
</returns>
<param name="message">
<attribution license="cc4" from="Microsoft" modified="false" />The message for which the Message Queuing (MSMQ) integration message properties are to be retrieved.</param>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Message Queuing (MSMQ) generates a message identifier when the message is sent. The identifier is composed of 20 bytes and includes two items: the machine GUID of the sending computer and a unique identifier for the message on the computer. The combination of the two items produces a message identifier that is unique on the network.</para>
<para>Message Queuing generates message identifiers for all messages, including acknowledgment and report messages. An acknowledgment message is generally sent by Message Queuing in response to the arrival or failure of an original sent message.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the message's identifier.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Label">
<MemberSignature Language="C#" Value="public string Label { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Label" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can use a message label for several purposes. For example, you can use it for display purposes or to selectively process messages based on the label value. It is not necessary to make the label unique across messages.</para>
<para>Message queue and message labels represent an application-defined value that can help identify the queue or message in human-readable terms. It is the responsibility of the application to interpret the label contents, which have no intrinsic meaning to Message Queuing.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets an application-defined Unicode string that describes the message.</para>
</summary>
</Docs>
</Member>
<Member MemberName="MessageType">
<MemberSignature Language="C#" Value="public Nullable&lt;System.Messaging.MessageType&gt; MessageType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.Messaging.MessageType&gt; MessageType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable&lt;System.Messaging.MessageType&gt;</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Message Queuing (MSMQ) typically sets this property when it sends the message. A Message Queuing message can be one of the following types: </para>
<list type="bullet">
<item>
<para>Normal, which is either a typical message sent from an application to a queue, or a response message returned to the sending application.</para>
</item>
<item>
<para>Acknowledgment, which Message Queuing generates whenever the sending application requests one. For example, Message Queuing can generate positive or negative messages to indicate that the original message arrived or was read. Message Queuing returns the appropriate acknowledgment message to the administration queue specified by the sending application.</para>
</item>
<item>
<para>Report, which is generated whenever a report queue is defined at the source Queue Manager. When tracing is enabled, Message Queuing sends a report message to the Message Queuing report queue each time the original message enters or leaves a Message Queuing server.</para>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the message type: Normal, Acknowledgment, or Report.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public const string Name;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string Name" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The constant value "MsmqIntegrationMessageProperty".</para>
</summary>
</Docs>
</Member>
<Member MemberName="Priority">
<MemberSignature Language="C#" Value="public Nullable&lt;System.Messaging.MessagePriority&gt; Priority { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.Messaging.MessagePriority&gt; Priority" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable&lt;System.Messaging.MessagePriority&gt;</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Priority affects how Message Queuing (MSMQ) handles the message both while it is en route and once it reaches its destination. Higher-priority messages are given preference during routing and inserted toward the front of the destination queue. Messages with the same priority are placed in the queue according to their arrival time.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the message priority, which determines where in the queue the message is placed.</para>
</summary>
</Docs>
</Member>
<Member MemberName="ResponseQueue">
<MemberSignature Language="C#" Value="public Uri ResponseQueue { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri ResponseQueue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Identifies the queue that receives application-generated response messages, which the receiving application returns to the sending application. The sending application specifies response queues when the application sends its messages. Any available queue can be specified as a response queue.</para>
<para>Messages returned to the response queue are application-specific. The application must define the contents of the messages as well as the action to take upon receipt of a message.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the queue that receives application-generated response messages.</para>
</summary>
</Docs>
</Member>
<Member MemberName="SenderId">
<MemberSignature Language="C#" Value="public byte[] SenderId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int8[] SenderId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the identifier of the sending user.</para>
</summary>
</Docs>
</Member>
<Member MemberName="SentTime">
<MemberSignature Language="C#" Value="public Nullable&lt;DateTime&gt; SentTime { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.DateTime&gt; SentTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable&lt;System.DateTime&gt;</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The sent time is adjusted to the local time of the computer on which the message was created. This time zone can be different from those of the source and destination queues.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the date and time on the sending computer that the message was sent by the source queue manager.</para>
</summary>
</Docs>
</Member>
<Member MemberName="TimeToReachQueue">
<MemberSignature Language="C#" Value="public Nullable&lt;TimeSpan&gt; TimeToReachQueue { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.TimeSpan&gt; TimeToReachQueue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable&lt;System.TimeSpan&gt;</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the interval specified by the <see cref="P:System.Messaging.Message.TimeToReachQueue" /> property expires before the message reaches its destination, MSMQ discards the message depending on the behavior indicated by the DeadLetterQueue property on the binding.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the maximum amount of time for the message to reach the queue.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>