Skip to content

Commit 3facd7a

Browse files
BillWagnerBillWagner
authored
Merge pull request #3687 from dotnet/master
Update live with current master
2 parents 7d03c24 + 94ea8ef commit 3facd7a

19 files changed

+428
-180
lines changed

‎xml/Microsoft.CLRAdmin/CDO.xml

Lines changed: 118 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,24 @@
4747
<Parameter Name="d" Type="System.UInt32" RefType="ref" />
4848
</Parameters>
4949
<Docs>
50-
<param name="a">To be added.</param>
51-
<param name="b">To be added.</param>
52-
<param name="c">To be added.</param>
53-
<param name="d">To be added.</param>
54-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
55-
<returns>To be added.</returns>
50+
<param name="a">A pointer to the <see cref="T:Microsoft.CLRAdmin.FORMATETC" /> defining the format, medium, and target device for notifications.</param>
51+
<param name="b">An <see cref="T:System.Runtime.InteropServices.ComTypes.ADVF" /> value specifying the requested behavior for the connection.</param>
52+
<param name="c">A pointer to the <see cref="T:System.Runtime.InteropServices.ComTypes.IAdviseSink" /> on the caller object.</param>
53+
<param name="d">A pointer to the connection set up by this call to the DAdvise method.</param>
54+
<summary>Creates a notification connection between a <see cref="M:Microsoft.CLRAdmin.CDO" /> object and a caller object, letting the caller receive notification of changes in the data for the data object.</summary>
55+
<returns>The DAdvise method supports the standard returns values E_INVALIDARG, E_UNEXPECTED, and E_OUTOFMEMORY, as well as the following return values:
56+
57+
58+
59+
| Return value | Description |
60+
| --- | --- |
61+
| S\_OK | The DAdvise method successfully created the connection. |
62+
| E\_NOTIMPL | The data object does not implement the DAdvise method. |
63+
| DV\_E\_LINDEX | lindex is not valid. |
64+
| DV\_E\_FORMATETC | The data pointer value is not valid. |
65+
| OLE\_E\_ADVISENOTSUPPORTED | The object does not support change notification. |</returns>
5666
<remarks>To be added.</remarks>
67+
<forInternalUseOnly />
5768
</Docs>
5869
</Member>
5970
<Member MemberName="DUnadvise">
@@ -78,10 +89,15 @@
7889
<Parameter Name="a" Type="System.UInt32" />
7990
</Parameters>
8091
<Docs>
81-
<param name="a">To be added.</param>
82-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
83-
<returns>To be added.</returns>
92+
<param name="a">The connection to destroy.</param>
93+
<summary>Destroys a notification connection that was created by an earlier call to the <see cref="M:Microsoft.CLRAdmin.CDO.DAdvise(System.IntPtr,System.UInt32,System.IntPtr,System.UInt32@)" /> method.</summary>
94+
<returns>| Return value | Description |
95+
| --- | --- |
96+
| S\_OK | The DUnadvise method successfully deleted the specified connection. |
97+
| OLE\_E\_NOCONNECTION | The specified connection is not a valid connection. |
98+
| OLE\_E\_ADVISENOTSUPPORTED | The object does not support change notification. |</returns>
8499
<remarks>To be added.</remarks>
100+
<forInternalUseOnly />
85101
</Docs>
86102
</Member>
87103
<Member MemberName="EnumDAdvise">
@@ -106,10 +122,18 @@
106122
<Parameter Name="a" Type="System.IntPtr" />
107123
</Parameters>
108124
<Docs>
109-
<param name="a">To be added.</param>
110-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
111-
<returns>To be added.</returns>
125+
<param name="a">The address of the <see cref="T:System.Runtime.InteropServices.ComTypes.IEnumSTATDATA" /> receiving the interface pointer to the new enumerator object. There are no connections if this call to the EnumDAdvise method sets <paramref name="a" /> to <see langword="null" />.</param>
126+
<summary>Retrieves a pointer to an object that can enumerate the notification connections that are currently maintained by this <see cref="T:Microsoft.CLRAdmin.CDO" /> object.</summary>
127+
<returns>The EnumDAdvise method supports the standard return value E_OUTOFMEMORY, as well as the following return values:
128+
129+
130+
131+
| Return value | Description |
132+
| --- | --- |
133+
| S\_OK | This call to the EnumDAdvise method successfully created the instance of the enumerator object.-or-There are no connections. |
134+
| OLE\_E\_ADVISENOTSUPPORTED | The object does not support change notification. |</returns>
112135
<remarks>To be added.</remarks>
136+
<forInternalUseOnly />
113137
</Docs>
114138
</Member>
115139
<Member MemberName="EnumFormatEtc">
@@ -165,11 +189,22 @@
165189
<Parameter Name="b" Type="System.IntPtr" />
166190
</Parameters>
167191
<Docs>
168-
<param name="a">To be added.</param>
169-
<param name="b">To be added.</param>
170-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
171-
<returns>To be added.</returns>
192+
<param name="a">A pointer to the <see cref="T:Microsoft.CLRAdmin.FORMATETC" /> defining the format, medium, and target device for calls to retrieve data.</param>
193+
<param name="b">An output pointer to a <see cref="T:Microsoft.CLRAdmin.FORMATETC" /> containing the most general information possible for a specific rendering, or <see langword="null" />, if the <see cref="M:Microsoft.CLRAdmin.CDO.GetCanonicalFormatEtc(System.IntPtr,System.IntPtr)" /> method returns DATA_S_SAMEFORMATETC.</param>
194+
<summary>Retrieves a pointer to a standard <see cref="T:Microsoft.CLRAdmin.FORMATETC" /> structure that is logically equivalent to, but not necessarily equal to, the <see cref="T:Microsoft.CLRAdmin.FORMATETC" /> structure that is referenced by the <paramref name="a" /> parameter.</summary>
195+
<returns>The GetCanonicalFormatEtc method supports the standard return values E_INVALIDARG, E_UNEXPECTED, and E_OUTOFMEMORY, as well as the following return values:
196+
197+
198+
199+
| Return value | Description |
200+
| --- | --- |
201+
| S\_OK | The returned FORMATETC is different from the structure passed in the parameters. |
202+
| DATA\_S\_SAMEFORMATETC | The returned FORMATETC is the same as the structure passed in the parameters and <see langword="null" /> is returned in <paramref name="b" />. |
203+
| DV\_E\_LINDEX | lindex is not valid. |
204+
| DV\_E\_FORMATETC | <paramref name="a" /> is not valid. |
205+
| OLE\_E\_NOTRUNNING | The object application is not running. |</returns>
172206
<remarks>To be added.</remarks>
207+
<forInternalUseOnly />
173208
</Docs>
174209
</Member>
175210
<Member MemberName="GetData">
@@ -195,11 +230,24 @@
195230
<Parameter Name="pMedium" Type="Microsoft.CLRAdmin.STGMEDIUM" RefType="ref" />
196231
</Parameters>
197232
<Docs>
198-
<param name="pFormat">To be added.</param>
199-
<param name="pMedium">To be added.</param>
200-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
201-
<returns>To be added.</returns>
233+
<param name="pFormat">A pointer to the <see cref="T:Microsoft.CLRAdmin.FORMATETC" /> defining the format, medium, and target device for calls to retrieve data.</param>
234+
<param name="pMedium">A pointer to the <see cref="T:Microsoft.CLRAdmin.STGMEDIUM" /> indicating the storage medium containing the returned data.</param>
235+
<summary>Renders the data that is described in the specified pFormat structure and transfers it to the <paramref name="pMedium" /> parameter.</summary>
236+
<returns>The GetData method supports the standard return values E_INVALIDARG, E_UNEXPECTED, and E_OUTOFMEMORY, as well as the following return values:
237+
238+
239+
240+
| Return value | Description |
241+
| --- | --- |
242+
| S\_OK | This call to the GetData method successfully retrieved and placed data in the provided storage medium. |
243+
| DV\_E\_LINDEX | lindex is not valid. |
244+
| DV\_E\_FORMATETC | <paramref name="pFormat" /> is not valid. |
245+
| DV\_E\_TYMED | tymed is not valid. |
246+
| DV\_E\_DVASPECT | dwAspect is not valid. |
247+
| OLE\_E\_NOTRUNNING | The object application is not running. |
248+
| STG\_E\_MEDIUMFULL | An error occurred when allocating the medium. |</returns>
202249
<remarks>To be added.</remarks>
250+
<forInternalUseOnly />
203251
</Docs>
204252
</Member>
205253
<Member MemberName="GetDataHere">
@@ -225,11 +273,24 @@
225273
<Parameter Name="pMedium" Type="Microsoft.CLRAdmin.STGMEDIUM" RefType="ref" />
226274
</Parameters>
227275
<Docs>
228-
<param name="pFormat">To be added.</param>
229-
<param name="pMedium">To be added.</param>
230-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
231-
<returns>To be added.</returns>
276+
<param name="pFormat">A pointer to the <see cref="T:Microsoft.CLRAdmin.FORMATETC" /> defining the format, medium, and target device for calls to retrieve data.</param>
277+
<param name="pMedium">A pointer to the <see cref="T:Microsoft.CLRAdmin.STGMEDIUM" /> indicating the storage medium containing the returned data.</param>
278+
<summary>Renders the data that is described in the specified pFormat structure and transfers it to the <paramref name="pMedium" /> parameter.</summary>
279+
<returns>The GetDataHere method supports the standard return values E_INVALIDARG, E_UNEXPECTED, and E_OUTOFMEMORY, as well as the following return values:
280+
281+
282+
283+
| Return value | Description |
284+
| --- | --- |
285+
| S\_OK | This call to the GetDataHere method successfully retrieved and placed data in the provided storage medium. |
286+
| DV\_E\_LINDEX | lindex is not valid. |
287+
| DV\_E\_FORMATETC | <paramref name="pFormat" /> is not valid. |
288+
| DV\_E\_TYMED | tymed is not valid. |
289+
| DV\_E\_DVASPECT | dwAspect is not valid. |
290+
| OLE\_E\_NOTRUNNING | The object application is not running. |
291+
| STG\_E\_MEDIUMFULL | An error occurred when allocating the medium. |</returns>
232292
<remarks>To be added.</remarks>
293+
<forInternalUseOnly />
233294
</Docs>
234295
</Member>
235296
<Member MemberName="Node">
@@ -275,10 +336,21 @@
275336
<Parameter Name="a" Type="System.IntPtr" />
276337
</Parameters>
277338
<Docs>
278-
<param name="a">To be added.</param>
279-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
280-
<returns>To be added.</returns>
339+
<param name="a">A pointer to the <see cref="T:Microsoft.CLRAdmin.FORMATETC" /> defining the format, medium, and target device for calls to retrieve data.</param>
340+
<summary>Determines whether the data object is capable of rendering the data described in the <see cref="T:Microsoft.CLRAdmin.FORMATETC" /> structure. Objects attempting a paste or drop operation can call this method before calling <see cref="M:Microsoft.CLRAdmin.CDO.GetData(Microsoft.CLRAdmin.FORMATETC@,Microsoft.CLRAdmin.STGMEDIUM@)" /> to get an indication of whether the operation may be successful.</summary>
341+
<returns>The QueryGetData method supports the standard return values E_INVALIDARG, E_UNEXPECTED, and E_OUTOFMEMORY, as well as the following return values:
342+
343+
344+
| Return value | Description |
345+
| --- | --- |
346+
| S\_OK | A subsequent call to the <see cref="M:Microsoft.CLRAdmin.CDO.GetData(Microsoft.CLRAdmin.FORMATETC@,Microsoft.CLRAdmin.STGMEDIUM@)" /> method probably will be successful. |
347+
| DV\_E\_LINDEX | lindex is not valid. |
348+
| DV\_E\_FORMATETC | <paramref name="a" /> is not valid. |
349+
| DV\_E\_TYMED | tymed is not valid. |
350+
| DV\_E\_DVASPECT | dwAspect value. |
351+
| OLE\_E\_NOTRUNNING | The object application is not running. |</returns>
281352
<remarks>To be added.</remarks>
353+
<forInternalUseOnly />
282354
</Docs>
283355
</Member>
284356
<Member MemberName="SetData">
@@ -305,12 +377,26 @@
305377
<Parameter Name="c" Type="System.Int32" />
306378
</Parameters>
307379
<Docs>
308-
<param name="a">To be added.</param>
309-
<param name="b">To be added.</param>
310-
<param name="c">To be added.</param>
311-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
312-
<returns>To be added.</returns>
380+
<param name="a">A pointer to the <see cref="T:Microsoft.CLRAdmin.FORMATETC" /> defining the format for the <see cref="T:Microsoft.CLRAdmin.CDO" /> object to use when interpreting the data contained in the storage medium.</param>
381+
<param name="b">A pointer to the <see cref="T:Microsoft.CLRAdmin.STGMEDIUM" /> defining the storage medium for the SetData method to use to pass the data.</param>
382+
<param name="c">
383+
<see langword="true" /> to specify that the called <see cref="T:Microsoft.CLRAdmin.CDO" /> object owns the storage medium after the call and must free the medium after it has been used; otherwise, <see langword="false" /> to specify the caller retains ownership of the storage medium and the data object uses the medium for the duration of the call only.</param>
384+
<summary>Transfers the data that is contained in the <see cref="T:Microsoft.CLRAdmin.STGMEDIUM" /> structure, referenced by <paramref name="a" />, to this instance of the <see cref="T:Microsoft.CLRAdmin.CDO" /> object.</summary>
385+
<returns>The SetData method supports the standard return values E_FAIL, E_INVALIDARG, E_UNEXPECTED, and E_OUTOFMEMORY, as well as the following return values:
386+
387+
388+
389+
| Return value | Description |
390+
| --- | --- |
391+
| S\_OK | This call to the SetData method successfully transferred the data. |
392+
| E\_NOTIMPL | The SetData method is not implemented for the <see cref="T:Microsoft.CLRAdmin.CDO" /> object. |
393+
| DV\_E\_LINDEX | lindex is not valid. |
394+
| DV\_E\_FORMATETC | pFormatEtc is not valid. |
395+
| DV\_E\_TYMED | tymed is not valid. |
396+
| DV\_E\_DVASPECT | dwAspect is not valid. |
397+
| OLE\_E\_NOTRUNNING | The object application is not running. |</returns>
313398
<remarks>To be added.</remarks>
399+
<forInternalUseOnly />
314400
</Docs>
315401
</Member>
316402
</Members>

‎xml/Microsoft.CLRAdmin/CData.xml

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,12 @@
7474
<Parameter Name="pInsertionAllowed" Type="System.Int32" RefType="ref" />
7575
</Parameters>
7676
<Docs>
77-
<param name="piDataObject">To be added.</param>
78-
<param name="piCallback">To be added.</param>
79-
<param name="pInsertionAllowed">To be added.</param>
80-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
77+
<param name="piDataObject">A pointer to the <see cref="T:Microsoft.CLRAdmin.IDataObject" /> on the data object of the menu to which the AddMenuItems is adding items to the shortcut menu.</param>
78+
<param name="piCallback">A pointer to an <see cref="T:Microsoft.CLRAdmin.IContextMenuCallback" /> that can add items to the shortcut menu.</param>
79+
<param name="pInsertionAllowed">The MMC-defined menu-item insertion points that can be used.</param>
80+
<summary>Adds items to an existing shortcut menu.</summary>
8181
<remarks>To be added.</remarks>
82+
<forInternalUseOnly />
8283
</Docs>
8384
</Member>
8485
<Member MemberName="Command">
@@ -104,10 +105,11 @@
104105
<Parameter Name="piDataObject" Type="Microsoft.CLRAdmin.IDataObject" />
105106
</Parameters>
106107
<Docs>
107-
<param name="lCommandID">To be added.</param>
108-
<param name="piDataObject">To be added.</param>
109-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
108+
<param name="lCommandID">The command identifier of the menu item.</param>
109+
<param name="piDataObject">A pointer to the <see cref="T:Microsoft.CLRAdmin.IDataObject" /> on the object for which the shortcut menu was displayed.</param>
110+
<summary>The Command method is called when one of the shortcut menu items that you added is selected.</summary>
110111
<remarks>To be added.</remarks>
112+
<forInternalUseOnly />
111113
</Docs>
112114
</Member>
113115
<Member MemberName="CompareObjects">

‎xml/Microsoft.CLRAdmin/CNode.xml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,11 @@
6868
<Parameter Name="b" Type="System.Byte[]" />
6969
</Parameters>
7070
<Docs>
71-
<param name="b">To be added.</param>
72-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
73-
<returns>To be added.</returns>
71+
<param name="b">The byte array containing the sequence of bytes to decode.</param>
72+
<summary>Decodes an array of byte-encoded data.</summary>
73+
<returns>A string that contains the results of decoding the specified sequence of bytes.</returns>
7474
<remarks>To be added.</remarks>
75+
<forInternalUseOnly />
7576
</Docs>
7677
</Member>
7778
<Member MemberName="Clone">
@@ -876,10 +877,11 @@
876877
<Parameter Name="input" Type="System.String" />
877878
</Parameters>
878879
<Docs>
879-
<param name="input">To be added.</param>
880-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
881-
<returns>To be added.</returns>
880+
<param name="input">The string containing the characters to encode.</param>
881+
<summary>Encodes a string as an array of bytes.</summary>
882+
<returns>A byte array containing the results of encoding the specified set of characters.</returns>
882883
<remarks>To be added.</remarks>
884+
<forInternalUseOnly />
883885
</Docs>
884886
</Member>
885887
</Members>

‎xml/Microsoft.CLRAdmin/CPropPage.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -199,10 +199,11 @@
199199
<Parameter Name="input" Type="System.String" />
200200
</Parameters>
201201
<Docs>
202-
<param name="input">To be added.</param>
203-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
204-
<returns>To be added.</returns>
202+
<param name="input">The string containing the characters to encode.</param>
203+
<summary>Encodes a string as an array of bytes.</summary>
204+
<returns>A byte array containing the results of encoding the specified set of characters.</returns>
205205
<remarks>To be added.</remarks>
206+
<forInternalUseOnly />
206207
</Docs>
207208
</Member>
208209
</Members>

‎xml/Microsoft.CLRAdmin/DialogProc.xml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,14 @@
2222
<ReturnType>System.Boolean</ReturnType>
2323
</ReturnValue>
2424
<Docs>
25-
<param name="hwndDlg">To be added.</param>
26-
<param name="uMsg">To be added.</param>
27-
<param name="wParam">To be added.</param>
28-
<param name="lParam">To be added.</param>
29-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
30-
<returns>To be added.</returns>
25+
<param name="hwndDlg">A handle to the dialog box.</param>
26+
<param name="uMsg">The message.</param>
27+
<param name="wParam">Additional message-specific information.</param>
28+
<param name="lParam">Additional message-specific information.</param>
29+
<summary>Processes messages that are sent to a modal or modeless dialog box.</summary>
30+
<returns>
31+
<see langword="true" /> if the DialogProc successfully processed the message; otherwise, <see langword="false" />.</returns>
3132
<remarks>To be added.</remarks>
33+
<forInternalUseOnly />
3234
</Docs>
3335
</Type>

‎xml/Microsoft.CLRAdmin/IContextMenuCallback.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@
4242
<Parameter Name="pItem" Type="Microsoft.CLRAdmin.CONTEXTMENUITEM" RefType="ref" />
4343
</Parameters>
4444
<Docs>
45-
<param name="pItem">To be added.</param>
46-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
45+
<param name="pItem">A pointer to a <see cref="T:Microsoft.CLRAdmin.CONTEXTMENUITEM" /> with the item to add.</param>
46+
<summary>Adds a single item to a shortcut menu.</summary>
4747
<remarks>To be added.</remarks>
48+
<forInternalUseOnly />
4849
</Docs>
4950
</Member>
5051
</Members>

0 commit comments

Comments
 (0)