Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 1 addition & 10 deletions xml/System.ServiceModel.Configuration/AuthenticationMode.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
</Base>
<Docs>
<summary>Specifies the authentication setting used for message exchange.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AnonymousForCertificate">
Expand All @@ -36,15 +35,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Specifies that the initiator is anonymous, and that the responder is authenticated.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The certificate of the responder is available out-of-band to the initiator.

]]></format>
</remarks>
<summary>Specifies that the initiator is anonymous, and that the responder is authenticated. The certificate of the responder is available out-of-band to the initiator.</summary>
</Docs>
</Member>
<Member MemberName="AnonymousForSslNegotiated">
Expand Down
17 changes: 6 additions & 11 deletions xml/System.ServiceModel.PeerResolvers/PeerResolverMode.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,12 @@
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
If the specified peer resolver is unavailable, a <xref:System.InvalidOperationException> will be thrown when an attempt to use the resolver is made.

## Remarks

If the specified peer resolver is unavailable, an <xref:System.InvalidOperationException> will be thrown when an attempt to use the resolver is made.

If `Auto` is specified, a custom resolver is used, if one is available. If one is unavailable, the PNRP peer resolver is used. A peer resolver is considered "available" if the <xref:System.ServiceModel.PeerResolvers.PeerCustomResolverSettings.Address%2A?displayProperty=nameWithType> and <xref:System.ServiceModel.PeerResolvers.PeerCustomResolverSettings.Binding%2A?displayProperty=nameWithType> properties are set on it.

]]></format>
</remarks>
</Docs>
Expand All @@ -44,14 +47,6 @@
<MemberValue>0</MemberValue>
<Docs>
<summary>Automatically determines the type of resolver to use from the information set on the binding.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
If available, a custom resolver is used. If one is unavailable, the PNRP peer resolver is used. A peer resolver is considered "available" if the <xref:System.ServiceModel.PeerResolvers.PeerCustomResolverSettings.Address%2A> and <xref:System.ServiceModel.PeerResolvers.PeerCustomResolverSettings.Binding%2A> properties are set on it.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Custom">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
Instances of this class are used as parameters in many of the methods of the <xref:System.ServiceModel.Security.Tokens.SecurityTokenParameters> class and in its derived classes when creating binding elements and certificates.
`SecurityTokenInclusionMode` enumeration members are used as parameters in many methods of the <xref:System.ServiceModel.Security.Tokens.SecurityTokenParameters> class and in its derived classes when creating binding elements and certificates.

]]></format>
</remarks>
Expand All @@ -45,7 +45,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>Token is always included in messages to the initiator and never to the recipient.</summary>
<summary>The token is always included in messages to the initiator and never to the recipient.</summary>
</Docs>
</Member>
<Member MemberName="AlwaysToRecipient">
Expand All @@ -67,7 +67,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Token is always included in messages to the recipient and never to the initiator.</summary>
<summary>The token is always included in messages to the recipient and never to the initiator.</summary>
</Docs>
</Member>
<Member MemberName="Never">
Expand Down Expand Up @@ -111,15 +111,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Token is included once.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The token must be included in only one message sent from the initiator to the recipient. References to the token may use an internal reference mechanism. Subsequent related messages sent between the recipient and the initiator may refer to the token using an external reference mechanism.

]]></format>
</remarks>
<summary>The token is included once. The token must be included in only one message sent from the initiator to the recipient. References to the token may use an internal reference mechanism. Subsequent related messages sent between the recipient and the initiator may refer to the token using an external reference mechanism.</summary>
</Docs>
</Member>
</Members>
Expand Down
12 changes: 2 additions & 10 deletions xml/System.ServiceModel/AddressFilterMode.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The value of the <xref:System.ServiceModel.AddressFilterMode> enumeration is set on the <xref:System.ServiceModel.ServiceBehaviorAttribute.AddressFilterMode%2A> property.
The value of the `AddressFilterMode` enumeration is set on the <xref:System.ServiceModel.ServiceBehaviorAttribute.AddressFilterMode%2A?displayProperty=nameWithType> property.

The longest prefix match criterion specified by Prefix requires that the destination address be matched by the largest number of leading address bits in the filter. The default value is Exact.

Expand Down Expand Up @@ -53,15 +53,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Indicates a filter that matches on any address of an incoming message.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
Using this value turns off the WCF address filter check. Any message, no matter what its WS-Addressing:To identity is accepted.

]]></format>
</remarks>
<summary>Indicates a filter that matches on any address of an incoming message. Using this value turns off the WCF address filter check. Any message, no matter what its WS-Addressing:To identity, is accepted.</summary>
</Docs>
</Member>
<Member MemberName="Exact">
Expand Down
28 changes: 9 additions & 19 deletions xml/System.ServiceModel/InstanceContextMode.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.ServiceModel.InstanceContext?displayProperty=nameWithType> manages the association between the channel and the user-defined service objects. Use the <xref:System.ServiceModel.InstanceContextMode> enumeration with the <xref:System.ServiceModel.ServiceBehaviorAttribute.InstanceContextMode%2A?displayProperty=nameWithType> property to specify the lifetime of the <xref:System.ServiceModel.InstanceContext> object. Windows Communication Foundation (WCF) can create a new <xref:System.ServiceModel.InstanceContext> object for every call, every session or specify that the <xref:System.ServiceModel.InstanceContext> object is bound to a single service object. For a working example, see the [Instancing](~/docs/framework/wcf/samples/instancing.md).

The Single value specifies that a single <xref:System.ServiceModel.InstanceContextMode.Single> object should be used for the lifetime of the service.

> [!NOTE]
> If the <xref:System.ServiceModel.ServiceBehaviorAttribute.InstanceContextMode%2A> value is set to Single the result is that your service can only process one message at a time unless you also set the <xref:System.ServiceModel.ServiceBehaviorAttribute.ConcurrencyMode%2A> value to <xref:System.ServiceModel.ConcurrencyMode.Multiple>.



The <xref:System.ServiceModel.InstanceContext?displayProperty=nameWithType> class manages the association between the channel and the user-defined service objects. Use the `InstanceContextMode` enumeration with the <xref:System.ServiceModel.ServiceBehaviorAttribute.InstanceContextMode%2A?displayProperty=nameWithType> property to specify the lifetime of the <xref:System.ServiceModel.InstanceContext> object. Windows Communication Foundation (WCF) can create a new <xref:System.ServiceModel.InstanceContext> object for every call, every session, or specify that the <xref:System.ServiceModel.InstanceContext> object is bound to a single service object. For a working example, see [Instancing](~/docs/framework/wcf/samples/instancing.md).

The `Single` value specifies that a single <xref:System.ServiceModel.InstanceContext> object should be used for the lifetime of the service. Several caveats are associated with the `Single` value:

- If the <xref:System.ServiceModel.ServiceBehaviorAttribute.InstanceContextMode%2A?displayProperty=nameWithType> value is set to `Single`, your service can only process one message at a time unless you also set the <xref:System.ServiceModel.ServiceBehaviorAttribute.ConcurrencyMode%2A?displayProperty=nameWithtype> value to <xref:System.ServiceModel.ConcurrencyMode.Multiple?displayProperty=nameWithType>.

- For singleton lifetime behavior (for example, if the host application calls the <xref:System.ServiceModel.ServiceHost.%23ctor%2A?displayProperty=nameWithType> constructor and passes an object to use as the service), the service class must set <xref:System.ServiceModel.ServiceBehaviorAttribute.InstanceContextMode%2A?displayProperty=nameWithType> to `Single`, or an exception is thrown when the service host is opened.

## Examples
The following code illustrates how to set the <xref:System.ServiceModel.InstanceContextMode> for a service class:

Expand Down Expand Up @@ -105,17 +105,7 @@
<MemberValue>2</MemberValue>
<Docs>
<summary>Only one <see cref="T:System.ServiceModel.InstanceContext" /> object is used for all incoming calls and is not recycled subsequent to the calls. If a service object does not exist, one is created.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

> [!NOTE]
> For singleton lifetime behavior (for example, if the host application calls the <xref:System.ServiceModel.ServiceHost.%23ctor%2A> constructor and passes an object to use as the service), the service class must set <xref:System.ServiceModel.ServiceBehaviorAttribute.InstanceContextMode%2A> to Single, or an exception is thrown when the service host is opened.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>
36 changes: 2 additions & 34 deletions xml/System.ServiceModel/ReceiveErrorHandling.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>An enumeration that specifies handling for a poison message.</summary>
<summary>Specifies handling for poison messages.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
A poison message is a message that fails repeated attempts to deliver to the application. This is applicable only when using a Message Queuing (MSMQ)-based binding. The default value is `Fault`, which faults the listener and therefore the ServiceHost. In the case where the service was to fault because of a poison message, a <xref:System.ServiceModel.MsmqPoisonMessageException> is thrown. The exception contains the `LookupId` of the MSMQ message that can be used to move the message out of the way using System.Messaging API. Certain values of the <xref:System.ServiceModel.ReceiveErrorHandling> enumeration such as `Reject` and `Move` are only available on [!INCLUDE[wv](~/includes/wv-md.md)]. You control poison message handling by setting the <xref:System.ServiceModel.Channels.MsmqBindingElementBase.ReceiveErrorHandling%2A> property to one of the values of this enumeration.
A *poison message* is a message that fails repeated attempts to deliver to the application. This is applicable only when using a Message Queuing (MSMQ)-based binding. The default value is `Fault`, which faults the listener and therefore the ServiceHost. In the case where the service was to fault because of a poison message, a <xref:System.ServiceModel.MsmqPoisonMessageException> is thrown. The exception contains the `LookupId` of the MSMQ message that can be used to move the message out of the way using System.Messaging API. Certain values of the <xref:System.ServiceModel.ReceiveErrorHandling> enumeration such as `Reject` and `Move` are only available on [!INCLUDE[wv](~/includes/wv-md.md)]. You control poison message handling by setting the <xref:System.ServiceModel.Channels.MsmqBindingElementBase.ReceiveErrorHandling%2A> property to one of the values of this enumeration.



Expand Down Expand Up @@ -55,14 +55,6 @@
<MemberValue>1</MemberValue>
<Docs>
<summary>This option drops the poison message. The message never gets delivered to the application. If the message's TTL had already expired at this point, then the message may appear in the sender's Dead Letter Queue. If not, the message does not appear anywhere. This option indicates that the user does not really care if the message is lost.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
Applicable platforms: [!INCLUDE[wxp](~/includes/wxp-md.md)], [!INCLUDE[ws2003](~/includes/ws2003-md.md)], and [!INCLUDE[wv](~/includes/wv-md.md)].

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Fault">
Expand All @@ -85,14 +77,6 @@
<MemberValue>0</MemberValue>
<Docs>
<summary>This option sends a fault to the listener that caused the ServiceHost to fault. The message must be removed from the application queue by some external mechanism before the application can continue to process messages from the queue.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
Applicable platforms: Windows XP, Windows Server 2003, and Windows Vista.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Move">
Expand All @@ -115,14 +99,6 @@
<MemberValue>3</MemberValue>
<Docs>
<summary>This moves the poison message to a Poison Message Queue for later processing by a poison message handling application.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
Applicable platforms: [!INCLUDE[wv](~/includes/wv-md.md)] only.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Reject">
Expand All @@ -145,14 +121,6 @@
<MemberValue>2</MemberValue>
<Docs>
<summary>This instructs MSMQ to send a negative acknowledgement back to the sending queue manager that the message cannot be received by the application. The message is placed in the sending queue manager's Dead Letter Queue.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
Applicable platforms: [!INCLUDE[wv](~/includes/wv-md.md)] only.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
27 changes: 4 additions & 23 deletions xml/System.ServiceProcess/PowerBroadcastStatus.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
<format type="text/markdown"><![CDATA[

## Remarks
<xref:System.ServiceProcess.PowerBroadcastStatus> is used by the <xref:System.ServiceProcess.ServiceBase> class to indicate a change in the system's power status. You can design your application to react to any power status change.

`PowerBroadcastStatus` is used by the <xref:System.ServiceProcess.ServiceBase> class to indicate a change in the system's power status. You can design your application to react to any power status change.

]]></format>
</remarks>
Expand Down Expand Up @@ -192,17 +193,7 @@
</ReturnValue>
<MemberValue>18</MemberValue>
<Docs>
<summary>The computer has woken up automatically to handle an event.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

> [!NOTE]
> If the system detects any user activity after broadcasting `ResumeAutomatic`, it will broadcast a `ResumeSuspend` event to let applications know they can resume full interaction with the user.

]]></format>
</remarks>
<summary>The computer has woken up automatically to handle an event. If the system detects any user activity after broadcasting <see langword="ResumeAutomatic" />, it broadcasts a <see langword="ResumeSuspend" /> event to let applications know they can resume full interaction with the user.</summary>
</Docs>
</Member>
<Member MemberName="ResumeCritical">
Expand All @@ -229,17 +220,7 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>The system has resumed operation after a critical suspension caused by a failing battery.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

> [!NOTE]
> Because a critical suspension occurs without prior notification, resources and data previously available may not be present when the application receives this event. The application should attempt to restore its state to the best of its ability.

]]></format>
</remarks>
<summary>The system has resumed operation after a critical suspension caused by a failing battery. Because a critical suspension occurs without prior notification, resources and data previously available may not be present when the application receives this event. The application should attempt to restore its state to the best of its ability.</summary>
</Docs>
</Member>
<Member MemberName="ResumeSuspend">
Expand Down
Loading