|
15 | 15 | </Base> |
16 | 16 | <Interfaces /> |
17 | 17 | <Docs> |
18 | | - <summary>The <see cref="T:System.DirectoryServices.Protocols.DsmlSoapConnection" /> class is an abstract class that cannot be instantiated. It enables stateless and stateful protocols to be handled similarly by providing session-oriented features.</summary> |
| 18 | + <summary>An abstract class that cannot be instantiated. It enables stateless and stateful protocols to be handled similarly by providing session-oriented features.</summary> |
19 | 19 | <remarks>To be added.</remarks> |
20 | 20 | </Docs> |
21 | 21 | <Members> |
|
33 | 33 | </AssemblyInfo> |
34 | 34 | <Parameters /> |
35 | 35 | <Docs> |
36 | | - <summary>The <see cref="M:System.DirectoryServices.Protocols.DsmlSoapConnection.#ctor" /> constructor initializes a new instance of a <see cref="T:System.DirectoryServices.Protocols.DsmlSoapConnection" /> class.</summary> |
| 36 | + <summary>Initializes a new instance of a <see cref="T:System.DirectoryServices.Protocols.DsmlSoapConnection" /> class.</summary> |
37 | 37 | <remarks>To be added.</remarks> |
38 | 38 | </Docs> |
39 | 39 | </Member> |
|
55 | 55 | </ReturnValue> |
56 | 56 | <Parameters /> |
57 | 57 | <Docs> |
58 | | - <summary>The <see cref="M:System.DirectoryServices.Protocols.DsmlSoapConnection.BeginSession" /> method instructs the DSML server to start a new session.</summary> |
| 58 | + <summary>Instructs the DSML server to start a new session.</summary> |
59 | 59 | <remarks> |
60 | 60 | <format type="text/markdown"><![CDATA[ |
61 | 61 | |
|
64 | 64 | |
65 | 65 | ]]></format> |
66 | 66 | </remarks> |
67 | | - <exception cref="T:System.InvalidOperationException">Thrown when a session is already open on the connection.</exception> |
68 | | - <exception cref="T:System.DirectoryServices.Protocols.DsmlInvalidDocumentException">Thrown when the XML returned from the Server in response to the BeginSession is not well-formed.</exception> |
69 | | - <exception cref="T:System.Net.WebException">Thrown when there is a communications failure with the DSML server.</exception> |
| 67 | + <exception cref="T:System.InvalidOperationException">A session is already open on the connection.</exception> |
| 68 | + <exception cref="T:System.DirectoryServices.Protocols.DsmlInvalidDocumentException">The XML returned from the Server in response to the BeginSession is not well-formed.</exception> |
| 69 | + <exception cref="T:System.Net.WebException">There is a communications failure with the DSML server.</exception> |
70 | 70 | </Docs> |
71 | 71 | </Member> |
72 | 72 | <Member MemberName="EndSession"> |
|
87 | 87 | </ReturnValue> |
88 | 88 | <Parameters /> |
89 | 89 | <Docs> |
90 | | - <summary>The <see cref="M:System.DirectoryServices.Protocols.DsmlSoapConnection.EndSession" /> method ends the session with the DSML server and clears the <see cref="P:System.DirectoryServices.Protocols.DsmlSoapConnection.SessionId" /> property.</summary> |
| 90 | + <summary>Ends the session with the DSML server and clears the <see cref="P:System.DirectoryServices.Protocols.DsmlSoapConnection.SessionId" /> property.</summary> |
91 | 91 | <remarks> |
92 | 92 | <format type="text/markdown"><![CDATA[ |
93 | 93 | |
94 | 94 | ## Remarks |
95 | 95 | The method will block while waiting for a response from the DSML server and will timeout according to the <xref:System.DirectoryServices.Protocols.DirectoryConnection.Timeout%2A> property. |
96 | 96 | |
97 | | - If the DSML server terminates the session, a <xref:System.Net.WebException> |
98 | | - |
99 | | - is thrown. If <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.SessionId%2A> is still valid after the exception is thrown, the request never reached the server and the connection is still considered valid. |
| 97 | + If the DSML server terminates the session, a <xref:System.Net.WebException> is thrown. If <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.SessionId%2A> is still valid after the exception is thrown, the request never reached the server and the connection is still considered valid. |
100 | 98 | |
101 | 99 | ]]></format> |
102 | 100 | </remarks> |
103 | | - <exception cref="T:System.Net.WebException">Thrown when a communications failure occurs with the DSML server.</exception> |
104 | | - <exception cref="T:System.InvalidOperationException">Thrown when there is no open session.</exception> |
| 101 | + <exception cref="T:System.Net.WebException">A communications failure occurred with the DSML server.</exception> |
| 102 | + <exception cref="T:System.InvalidOperationException">There is no open session.</exception> |
105 | 103 | </Docs> |
106 | 104 | </Member> |
107 | 105 | <Member MemberName="SessionId"> |
|
121 | 119 | <ReturnType>System.String</ReturnType> |
122 | 120 | </ReturnValue> |
123 | 121 | <Docs> |
124 | | - <summary>The <see cref="P:System.DirectoryServices.Protocols.DsmlSoapConnection.SessionId" /> property contains the active session ID.</summary> |
125 | | - <value>The active session ID.</value> |
126 | | - <remarks> |
127 | | - <format type="text/markdown"><![CDATA[ |
128 | | - |
129 | | -## Remarks |
130 | | - A null value signifies no active session. |
131 | | - |
132 | | - ]]></format> |
133 | | - </remarks> |
| 122 | + <summary>Gets the active session ID.</summary> |
| 123 | + <value>The active session ID, or <see langword="null" /> if there is no active session.</value> |
| 124 | + <remarks>To be added.</remarks> |
134 | 125 | </Docs> |
135 | 126 | </Member> |
136 | 127 | <Member MemberName="SoapRequestHeader"> |
|
150 | 141 | <ReturnType>System.Xml.XmlNode</ReturnType> |
151 | 142 | </ReturnValue> |
152 | 143 | <Docs> |
153 | | - <summary>The <see cref="P:System.DirectoryServices.Protocols.DsmlSoapConnection.SoapRequestHeader" /> property contains the SOAP Header attached to outgoing requests.</summary> |
| 144 | + <summary>Gets or sets the SOAP Header attached to outgoing requests.</summary> |
154 | 145 | <value>The SOAP Header attached to outgoing requests.</value> |
155 | 146 | <remarks> |
156 | 147 | <format type="text/markdown"><![CDATA[ |
157 | 148 | |
158 | | -## Remarks |
159 | | - The API uses <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.BeginSession%2A> and <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.EndSession%2A> to track the lifetime of a session. |
| 149 | +## Remarks |
| 150 | +
|
| 151 | +The API uses <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.BeginSession%2A> and <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.EndSession%2A> to track the lifetime of a session. |
160 | 152 | |
161 | | - **Caution** Attaching an EndSession header to the <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.SoapRequestHeader%2A> causes the API to become inconsistent with the connection and should be avoided. |
| 153 | +> [!CAUTION] |
| 154 | +> Attaching an `EndSession` header to the <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.SoapRequestHeader%2A> causes the API to become inconsistent with the connection and should be avoided. |
162 | 155 | |
163 | 156 | ]]></format> |
164 | 157 | </remarks> |
|
0 commit comments