Skip to content

Update nf-ioapiset-getqueuedcompletionstatus.md #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Karl-Bridge-Microsoft merged 2 commits into from
Feb 20, 2020
Merged

Update nf-ioapiset-getqueuedcompletionstatus.md #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60631e3
Update nf-ioapiset-getqueuedcompletionstatus.md
hsebs Feb 20, 2020
6589bde
Update nf-ioapiset-getqueuedcompletionstatus.md
Karl-Bridge-Microsoft Feb 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 2 additions & 32 deletions sdk-api-src/content/ioapiset/nf-ioapiset-getqueuedcompletionstatus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,69 +62,46 @@ To dequeue multiple I/O completion packets at once, use the <a href="https://doc

## -parameters




### -param CompletionPort [in]

A handle to the completion port. To create a completion port, use the
<a href="https://docs.microsoft.com/windows/desktop/FileIO/createiocompletionport">CreateIoCompletionPort</a> function.


### -param lpNumberOfBytesTransferred

TBD

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
<a href="https://docs.microsoft.com/windows/desktop/FileIO/createiocompletionport">CreateIoCompletionPort</a>.


### -param lpOverlapped [out]

A pointer to a variable that receives the address of the
<a href="https://docs.microsoft.com/windows/desktop/api/minwinbase/ns-minwinbase-overlapped">OVERLAPPED</a> 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
<a href="https://docs.microsoft.com/windows/desktop/api/minwinbase/ns-minwinbase-overlapped">OVERLAPPED</a> structure, an application can prevent completion port notification. This is done by specifying a valid event handle for the <b>hEvent</b> member of the <b>OVERLAPPED</b> 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 <b>FALSE</b>, and sets *<i>lpOverlapped</i> to <b>NULL</b>.

If <i>dwMilliseconds</i> is <b>INFINITE</b>, the function will never time out. If <i>dwMilliseconds</i> 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



Returns nonzero (<b>TRUE</b>) if successful or zero (<b>FALSE</b>) otherwise.

To get extended error information, call
To get extended error information, call
<a href="https://docs.microsoft.com/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a>.

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 <b>GetQueuedCompletionStatus</b> fails because the completion port handle associated with it is closed while the call is outstanding, the function returns <b>FALSE</b>, <i>*lpOverlapped</i> will be <b>NULL</b>, and <a href="https://docs.microsoft.com/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a> will return <b>ERROR_ABANDONED_WAIT_0</b>.
Expand Down Expand Up @@ -200,16 +177,9 @@ Yes
</td>
</tr>
</table>





## -see-also




<a href="https://docs.microsoft.com/windows/desktop/api/namedpipeapi/nf-namedpipeapi-connectnamedpipe">ConnectNamedPipe</a>


Expand Down