Skip to content

Commit 9b5e6ca

Browse files
committed
Merged PR 20550: Update return description for CopyAsync and CopyAndCloseAsync
Update return info for async file operations based on community feedback in GitHub Issue: #2373
2 parents 877b004 + f4487d0 commit 9b5e6ca

3 files changed

Lines changed: 26 additions & 5 deletions

File tree

windows.storage.streams/randomaccessstream_copyandcloseasync_661963778.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,29 @@ public Windows.Foundation.IAsyncOperationWithProgress<ulong, ulong> CopyAndClose
1010
# Windows.Storage.Streams.RandomAccessStream.CopyAndCloseAsync
1111

1212
## -description
13+
1314
Copies a source stream to a destination stream and waits for the copy operation to complete.
1415

1516
## -parameters
17+
1618
### -param source
19+
1720
The stream to copy data from.
1821

1922
### -param destination
23+
2024
The stream to copy data to.
2125

2226
## -returns
23-
The asynchronous operation.
27+
28+
The byte writer operation. The first integer represents the number of bytes written. The second integer represents the progress of the write operation.
2429

2530
## -remarks
31+
2632
The CopyAndCloseAsync method is similar to [CopyAsync](randomaccessstream_copyasync_1577084715.md) but also calls and waits for [FlushAsync](ioutputstream_flushasync_491532439.md) and [Close](/windows/desktop/api/windows.foundation/nf-windows-foundation-iclosable-close) on the output stream before its asynchronous operation completes.
2733

2834
## -examples
2935

3036
## -see-also
37+
38+
[IAsyncOperationWithProgress&lt;ulong, ulong&gt;](../windows.foundation/iasyncoperationwithprogress_2.md)

windows.storage.streams/randomaccessstream_copyasync_1577084715.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,27 @@ public Windows.Foundation.IAsyncOperationWithProgress<ulong, ulong> CopyAsync(Wi
1010
# Windows.Storage.Streams.RandomAccessStream.CopyAsync
1111

1212
## -description
13+
1314
Copies a source stream to a destination stream.
1415

1516
## -parameters
17+
1618
### -param source
19+
1720
The stream to copy data from.
1821

1922
### -param destination
23+
2024
The stream to copy data to.
2125

2226
## -returns
23-
The asynchronous operation.
27+
28+
The byte writer operation. The first integer represents the number of bytes written. The second integer represents the progress of the write operation.
2429

2530
## -remarks
2631

2732
## -examples
2833

2934
## -see-also
30-
[CopyAsync(IInputStream, IOutputStream, UInt64)](randomaccessstream_copyasync_651010873.md)
35+
36+
[CopyAsync(IInputStream, IOutputStream, UInt64)](randomaccessstream_copyasync_651010873.md), [IAsyncOperationWithProgress&lt;ulong, ulong&gt;](../windows.foundation/iasyncoperationwithprogress_2.md)

windows.storage.streams/randomaccessstream_copyasync_651010873.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,31 @@ public Windows.Foundation.IAsyncOperationWithProgress<ulong, ulong> CopyAsync(Wi
1010
# Windows.Storage.Streams.RandomAccessStream.CopyAsync
1111

1212
## -description
13+
1314
Copies the specified number of bytes from a source stream to a destination stream.
1415

1516
## -parameters
17+
1618
### -param source
19+
1720
The stream to copy data from.
1821

1922
### -param destination
23+
2024
The stream to copy data to.
2125

2226
### -param bytesToCopy
27+
2328
The number of bytes to copy.
2429

2530
## -returns
26-
The asynchronous operation.
31+
32+
The byte writer operation. The first integer represents the number of bytes written. The second integer represents the progress of the write operation.
2733

2834
## -remarks
2935

3036
## -examples
3137

3238
## -see-also
33-
[CopyAsync(IInputStream, IOutputStream)](randomaccessstream_copyasync_1577084715.md)
39+
40+
[CopyAsync(IInputStream, IOutputStream)](randomaccessstream_copyasync_1577084715.md), [IAsyncOperationWithProgress&lt;ulong, ulong&gt;](../windows.foundation/iasyncoperationwithprogress_2.md)

0 commit comments

Comments
 (0)