INDAdapter::GetFileHandle Method

Retrieves the adapter's file handle.

Syntax

HANDLE GetFileHandle();

Parameters

This method has no parameters.

Return Value

File handle used for performing overlapped requests on the adapter or its resources. The returned file handle must have been opened for overlapped I/O.

If the method fails, the handle is set to INVALID_HANDLE_VALUE.

Implementation Notes

Providers must ensure that a misbehaved client that calls CloseHandle on an adapter's file handle does not leak system resources, cause adverse effects on system stability, or another application's ability to use the adapter.

Remarks

You could use the handle to:

• Bind to an I/O completion port if you want to get notification of overlapped operations (for example, memory registration or completion queue notification) delivered to an I/O completion port.
• Associate the handle with the system thread pool using the BindIoCompletionCallback function.
• Change the behavior of completions reported to any associated I/O completion port by a call to the SetFileCompletionNotificationModes function.

Requirements

See Also

INDAdapter

Send comments about this topic to Microsoft

Build date: 7/2/2010