From 60631e3d30d5372e40834da684ed58da9c20e2cc Mon Sep 17 00:00:00 2001 From: Heesung Kim Date: Fri, 21 Feb 2020 02:36:21 +0900 Subject: [PATCH 1/2] Update nf-ioapiset-getqueuedcompletionstatus.md Add description for lpNumberOfBytesTransferred --- .../ioapiset/nf-ioapiset-getqueuedcompletionstatus.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/sdk-api-src/content/ioapiset/nf-ioapiset-getqueuedcompletionstatus.md b/sdk-api-src/content/ioapiset/nf-ioapiset-getqueuedcompletionstatus.md index 291fbdbc4c50..46852cf7f05c 100644 --- a/sdk-api-src/content/ioapiset/nf-ioapiset-getqueuedcompletionstatus.md +++ b/sdk-api-src/content/ioapiset/nf-ioapiset-getqueuedcompletionstatus.md @@ -73,7 +73,7 @@ A handle to the completion port. To create a completion port, use the ### -param lpNumberOfBytesTransferred -TBD +A pointer to a variable that receives the number of bytes transferred during an I/O operation that has completed. ### -param lpCompletionKey [out] @@ -102,11 +102,6 @@ The number of milliseconds that the caller is willing to wait for a completion p If dwMilliseconds is INFINITE, the function will never time out. If dwMilliseconds is zero and there is no I/O operation to dequeue, the function will time out immediately. -#### - lpNumberOfBytes [out] - -A pointer to a variable that receives the number of bytes transferred during an I/O operation that has completed. - - ## -returns From 6589bdefcfd00faadd6268edc2d0e604c1a22de7 Mon Sep 17 00:00:00 2001 From: KB Date: Thu, 20 Feb 2020 14:08:11 -0800 Subject: [PATCH 2/2] Update nf-ioapiset-getqueuedcompletionstatus.md --- .../nf-ioapiset-getqueuedcompletionstatus.md | 29 ++----------------- 1 file changed, 2 insertions(+), 27 deletions(-) diff --git a/sdk-api-src/content/ioapiset/nf-ioapiset-getqueuedcompletionstatus.md b/sdk-api-src/content/ioapiset/nf-ioapiset-getqueuedcompletionstatus.md index 46852cf7f05c..55095c6413b4 100644 --- a/sdk-api-src/content/ioapiset/nf-ioapiset-getqueuedcompletionstatus.md +++ b/sdk-api-src/content/ioapiset/nf-ioapiset-getqueuedcompletionstatus.md @@ -62,39 +62,28 @@ To dequeue multiple I/O completion packets at once, use the CreateIoCompletionPort function. - ### -param lpNumberOfBytesTransferred -A pointer to a variable that receives the number of bytes transferred during an I/O operation that has completed. - +A pointer to a variable that receives the number of bytes transferred in a completed I/O operation. ### -param lpCompletionKey [out] A pointer to a variable that receives the completion key value associated with the file handle whose I/O operation has completed. A completion key is a per-file key that is specified in a call to CreateIoCompletionPort. - ### -param lpOverlapped [out] A pointer to a variable that receives the address of the OVERLAPPED structure that was specified when the completed I/O operation was started. - - - - Even if you have passed the function a file handle associated with a completion port and a valid OVERLAPPED structure, an application can prevent completion port notification. This is done by specifying a valid event handle for the hEvent member of the OVERLAPPED structure, and setting its low-order bit. A valid event handle whose low-order bit is set keeps I/O completion from being queued to the completion port. - ### -param dwMilliseconds [in] The number of milliseconds that the caller is willing to wait for a completion packet to appear at the completion port. If a completion packet does not appear within the specified time, the function times out, returns FALSE, and sets *lpOverlapped to NULL. @@ -104,22 +93,15 @@ If dwMilliseconds is INFINITE, the function will never time out. I ## -returns - - Returns nonzero (TRUE) if successful or zero (FALSE) otherwise. - To get extended error information, call +To get extended error information, call GetLastError. For more information, see the Remarks section. - - - ## -remarks - - This function associates a thread with the specified completion port. A thread can be associated with at most one completion port. If a call to GetQueuedCompletionStatus fails because the completion port handle associated with it is closed while the call is outstanding, the function returns FALSE, *lpOverlapped will be NULL, and GetLastError will return ERROR_ABANDONED_WAIT_0. @@ -195,16 +177,9 @@ Yes -  - - - ## -see-also - - - ConnectNamedPipe