Skip to content

Commit ff47d48

Browse files
AaronRobinsonMSFTAaronRobinsonMSFT
authored
Clarify IStream::Write doc (#10249)
1 parent a8a9b8c commit ff47d48

File tree

1 file changed

+64
-64
lines changed

1 file changed

+64
-64
lines changed

‎xml/System.Runtime.InteropServices.ComTypes/IStream.xml

Lines changed: 64 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@
6464
<Docs>
6565
<summary>Provides the managed definition of the <see langword="IStream" /> interface, with <see langword="ISequentialStream" /> functionality.</summary>
6666
<remarks>
67-
<format type="text/markdown"><![CDATA[
68-
69-
## Remarks
70-
For more information, see the documentation for the [IStream](/windows/win32/api/objidl/nn-objidl-istream) and [ISequentialStream](/windows/win32/api/objidl/nn-objidl-isequentialstream) interfaces.
71-
72-
The common language runtime throws an exception when a COM method in native code returns an `HRESULT` other than `S_OK`. For more information, see [How to: Map HRESULTs and Exceptions](/dotnet/framework/interop/how-to-map-hresults-and-exceptions).
73-
67+
<format type="text/markdown"><![CDATA[
68+
69+
## Remarks
70+
For more information, see the documentation for the [IStream](/windows/win32/api/objidl/nn-objidl-istream) and [ISequentialStream](/windows/win32/api/objidl/nn-objidl-isequentialstream) interfaces.
71+
72+
The common language runtime throws an exception when a COM method in native code returns an `HRESULT` other than `S_OK`. For more information, see [How to: Map HRESULTs and Exceptions](/dotnet/framework/interop/how-to-map-hresults-and-exceptions).
73+
7474
]]></format>
7575
</remarks>
7676
<related type="ExternalDocumentation" href="/windows/win32/api/objidl/nn-objidl-istream">IStream</related>
@@ -122,11 +122,11 @@
122122
<param name="ppstm">When this method returns, contains the new stream object. This parameter is passed uninitialized.</param>
123123
<summary>Creates a new stream object with its own seek pointer that references the same bytes as the original stream.</summary>
124124
<remarks>
125-
<format type="text/markdown"><![CDATA[
126-
127-
## Remarks
128-
For more information, see the existing documentation for [IStream::Clone](/windows/win32/api/objidl/nf-objidl-istream-clone).
129-
125+
<format type="text/markdown"><![CDATA[
126+
127+
## Remarks
128+
For more information, see the existing documentation for [IStream::Clone](/windows/win32/api/objidl/nf-objidl-istream-clone).
129+
130130
]]></format>
131131
</remarks>
132132
</Docs>
@@ -176,11 +176,11 @@
176176
<param name="grfCommitFlags">A value that controls how the changes for the stream object are committed.</param>
177177
<summary>Ensures that any changes made to a stream object that is open in transacted mode are reflected in the parent storage.</summary>
178178
<remarks>
179-
<format type="text/markdown"><![CDATA[
180-
181-
## Remarks
182-
For more information, see the existing documentation for [IStream::Commit](/windows/win32/api/objidl/nf-objidl-istream-commit).
183-
179+
<format type="text/markdown"><![CDATA[
180+
181+
## Remarks
182+
For more information, see the existing documentation for [IStream::Commit](/windows/win32/api/objidl/nf-objidl-istream-commit).
183+
184184
]]></format>
185185
</remarks>
186186
</Docs>
@@ -236,11 +236,11 @@
236236
<param name="pcbWritten">On successful return, contains the actual number of bytes written to the destination.</param>
237237
<summary>Copies a specified number of bytes from the current seek pointer in the stream to the current seek pointer in another stream.</summary>
238238
<remarks>
239-
<format type="text/markdown"><![CDATA[
240-
241-
## Remarks
242-
For more information, see the existing documentation for [IStream::CopyTo](/windows/win32/api/objidl/nf-objidl-istream-copyto).
243-
239+
<format type="text/markdown"><![CDATA[
240+
241+
## Remarks
242+
For more information, see the existing documentation for [IStream::CopyTo](/windows/win32/api/objidl/nf-objidl-istream-copyto).
243+
244244
]]></format>
245245
</remarks>
246246
</Docs>
@@ -294,11 +294,11 @@
294294
<param name="dwLockType">The requested restrictions on accessing the range.</param>
295295
<summary>Restricts access to a specified range of bytes in the stream.</summary>
296296
<remarks>
297-
<format type="text/markdown"><![CDATA[
298-
299-
## Remarks
300-
For more information, see the existing documentation for [IStream::LockRegion](/windows/win32/api/objidl/nf-objidl-istream-lockregion).
301-
297+
<format type="text/markdown"><![CDATA[
298+
299+
## Remarks
300+
For more information, see the existing documentation for [IStream::LockRegion](/windows/win32/api/objidl/nf-objidl-istream-lockregion).
301+
302302
]]></format>
303303
</remarks>
304304
</Docs>
@@ -350,14 +350,14 @@
350350
<Docs>
351351
<param name="pv">When this method returns, contains the data read from the stream. This parameter is passed uninitialized.</param>
352352
<param name="cb">The number of bytes to read from the stream object.</param>
353-
<param name="pcbRead">A pointer to a <see langword="ULONG" /> variable that receives the actual number of bytes read from the stream object.</param>
353+
<param name="pcbRead">A pointer to an <see langword="uint" /> variable that receives the actual number of bytes read from the stream object.</param>
354354
<summary>Reads a specified number of bytes from the stream object into memory starting at the current seek pointer.</summary>
355355
<remarks>
356-
<format type="text/markdown"><![CDATA[
357-
358-
## Remarks
359-
For more information, see the existing documentation for [ISequentialStream::Read](/windows/win32/api/objidl/nf-objidl-isequentialstream-read).
360-
356+
<format type="text/markdown"><![CDATA[
357+
358+
## Remarks
359+
For more information, see the existing documentation for [ISequentialStream::Read](/windows/win32/api/objidl/nf-objidl-isequentialstream-read).
360+
361361
]]></format>
362362
</remarks>
363363
</Docs>
@@ -404,11 +404,11 @@
404404
<Docs>
405405
<summary>Discards all changes that have been made to a transacted stream since the last <see cref="M:System.Runtime.InteropServices.ComTypes.IStream.Commit(System.Int32)" /> call.</summary>
406406
<remarks>
407-
<format type="text/markdown"><![CDATA[
408-
409-
## Remarks
410-
For more information, see the existing documentation for [IStream::Revert](/windows/win32/api/objidl/nf-objidl-istream-revert).
411-
407+
<format type="text/markdown"><![CDATA[
408+
409+
## Remarks
410+
For more information, see the existing documentation for [IStream::Revert](/windows/win32/api/objidl/nf-objidl-istream-revert).
411+
412412
]]></format>
413413
</remarks>
414414
</Docs>
@@ -462,11 +462,11 @@
462462
<param name="plibNewPosition">On successful return, contains the offset of the seek pointer from the beginning of the stream.</param>
463463
<summary>Changes the seek pointer to a new location relative to the beginning of the stream, to the end of the stream, or to the current seek pointer.</summary>
464464
<remarks>
465-
<format type="text/markdown"><![CDATA[
466-
467-
## Remarks
468-
For more information, see the existing documentation for [IStream::Seek](/windows/win32/api/objidl/nf-objidl-istream-seek).
469-
465+
<format type="text/markdown"><![CDATA[
466+
467+
## Remarks
468+
For more information, see the existing documentation for [IStream::Seek](/windows/win32/api/objidl/nf-objidl-istream-seek).
469+
470470
]]></format>
471471
</remarks>
472472
</Docs>
@@ -516,11 +516,11 @@
516516
<param name="libNewSize">The new size of the stream as a number of bytes.</param>
517517
<summary>Changes the size of the stream object.</summary>
518518
<remarks>
519-
<format type="text/markdown"><![CDATA[
520-
521-
## Remarks
522-
For more information, see the existing documentation for [IStream::SetSize](/windows/win32/api/objidl/nf-objidl-istream-setsize).
523-
519+
<format type="text/markdown"><![CDATA[
520+
521+
## Remarks
522+
For more information, see the existing documentation for [IStream::SetSize](/windows/win32/api/objidl/nf-objidl-istream-setsize).
523+
524524
]]></format>
525525
</remarks>
526526
</Docs>
@@ -572,11 +572,11 @@
572572
<param name="grfStatFlag">Members in the <see langword="STATSTG" /> structure that this method does not return, thus saving some memory allocation operations.</param>
573573
<summary>Retrieves the <see cref="T:System.Runtime.InteropServices.STATSTG" /> structure for this stream.</summary>
574574
<remarks>
575-
<format type="text/markdown"><![CDATA[
576-
577-
## Remarks
578-
For more information, see the existing documentation for [IStream::Stat](/windows/win32/api/objidl/nf-objidl-istream-stat).
579-
575+
<format type="text/markdown"><![CDATA[
576+
577+
## Remarks
578+
For more information, see the existing documentation for [IStream::Stat](/windows/win32/api/objidl/nf-objidl-istream-stat).
579+
580580
]]></format>
581581
</remarks>
582582
</Docs>
@@ -630,11 +630,11 @@
630630
<param name="dwLockType">The access restrictions previously placed on the range.</param>
631631
<summary>Removes the access restriction on a range of bytes previously restricted with the <see cref="M:System.Runtime.InteropServices.ComTypes.IStream.LockRegion(System.Int64,System.Int64,System.Int32)" /> method.</summary>
632632
<remarks>
633-
<format type="text/markdown"><![CDATA[
634-
635-
## Remarks
636-
For more information, see the existing documentation for [IStream::UnlockRegion](/windows/win32/api/objidl/nf-objidl-istream-unlockregion).
637-
633+
<format type="text/markdown"><![CDATA[
634+
635+
## Remarks
636+
For more information, see the existing documentation for [IStream::UnlockRegion](/windows/win32/api/objidl/nf-objidl-istream-unlockregion).
637+
638638
]]></format>
639639
</remarks>
640640
</Docs>
@@ -685,14 +685,14 @@
685685
<Docs>
686686
<param name="pv">The buffer to write this stream to.</param>
687687
<param name="cb">The number of bytes to write to the stream.</param>
688-
<param name="pcbWritten">On successful return, contains the actual number of bytes written to the stream object. If the caller sets this pointer to <see cref="F:System.IntPtr.Zero" />, this method does not provide the actual number of bytes written.</param>
688+
<param name="pcbWritten">A pointer to a <see langword="uint" /> variable where this method writes the actual number of bytes written to the stream object. The caller can set this pointer to <see cref="F:System.IntPtr.Zero" />, in which case this method does not provide the actual number of bytes written.</param>
689689
<summary>Writes a specified number of bytes into the stream object starting at the current seek pointer.</summary>
690690
<remarks>
691-
<format type="text/markdown"><![CDATA[
692-
693-
## Remarks
694-
For more information, see the existing documentation for [ISequentialStream::Write](/windows/win32/api/objidl/nf-objidl-isequentialstream-write).
695-
691+
<format type="text/markdown"><![CDATA[
692+
693+
## Remarks
694+
For more information, see the existing documentation for [ISequentialStream::Write](/windows/win32/api/objidl/nf-objidl-isequentialstream-write).
695+
696696
]]></format>
697697
</remarks>
698698
</Docs>

0 commit comments

Comments
 (0)