wdfrequest.h header
This header is used by wdf. For more information, see:
wdfrequest.h contains the following programming interfaces:
Functions
| WDF_REQUEST_COMPLETION_PARAMS_INIT The WDF_REQUEST_COMPLETION_PARAMS_INIT function initializes a WDF_REQUEST_COMPLETION_PARAMS structure. |
| WDF_REQUEST_FORWARD_OPTIONS_INIT The WDF_REQUEST_FORWARD_OPTIONS_INIT function initializes a WDF_REQUEST_FORWARD_OPTIONS structure. |
| WDF_REQUEST_PARAMETERS_INIT The WDF_REQUEST_PARAMETERS_INIT function initializes a WDF_REQUEST_PARAMETERS structure. |
| WDF_REQUEST_REUSE_PARAMS_INIT The WDF_REQUEST_REUSE_PARAMS_INIT function initializes a driver's WDF_REQUEST_REUSE_PARAMS structure. |
| WDF_REQUEST_REUSE_PARAMS_SET_NEW_IRP The WDF_REQUEST_REUSE_PARAMS_SET_NEW_IRP function sets a new IRP in a driver's WDF_REQUEST_REUSE_PARAMS structure. |
| WDF_REQUEST_SEND_OPTIONS_INIT The WDF_REQUEST_SEND_OPTIONS_INIT function initializes a driver's WDF_REQUEST_SEND_OPTIONS structure. |
| WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT The WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT function sets a time-out value in a driver's WDF_REQUEST_SEND_OPTIONS structure. |
| WdfRequestAllocateTimer The WdfRequestAllocateTimer method allocates a timer for a specified I/O request. |
| WdfRequestCancelSentRequest The WdfRequestCancelSentRequest method attempts to cancel an I/O request that the caller previously submitted to an I/O target. |
| WdfRequestChangeTarget The WdfRequestChangeTarget method verifies that a specified I/O request can be sent to a specified I/O target. |
| WdfRequestComplete The WdfRequestComplete method completes a specified I/O request and supplies a completion status. |
| WdfRequestCompleteWithInformation The WdfRequestCompleteWithInformation method stores completion information and then completes a specified I/O request with a supplied completion status. |
| WdfRequestCompleteWithPriorityBoost The WdfRequestCompleteWithPriorityBoost method completes a specified I/O request and supplies a completion status. It also specifies a value that the system can use to boost the run-time priority of the thread that requested the I/O operation. |
| WdfRequestCreate The WdfRequestCreate method creates an empty framework request object. |
| WdfRequestCreateFromIrp The WdfRequestCreateFromIrp method creates a framework request object from a specified WDM IRP. |
| WdfRequestFormatRequestUsingCurrentType The WdfRequestFormatRequestUsingCurrentType method formats a specified I/O request so that the driver can forward it, unmodified, to the driver's local I/O target. |
| WdfRequestForwardToIoQueue The WdfRequestForwardToIoQueue method requeues an I/O request to one of the calling driver's I/O queues. |
| WdfRequestForwardToParentDeviceIoQueue The WdfRequestForwardToParentDeviceIoQueue method requeues an I/O request from a child device's I/O queue to a specified I/O queue of the child's parent device. |
| WdfRequestGetCompletionParams The WdfRequestGetCompletionParams method retrieves the I/O completion parameters that are associated with a specified framework request object. |
| WdfRequestGetEffectiveIoType The WdfRequestGetEffectiveIoType method returns the buffer access method that UMDF is using for the data buffers of the specified I/O request. |
| WdfRequestGetFileObject The WdfRequestGetFileObject method retrieves the framework file object that is associated with a specified I/O request. |
| WdfRequestGetInformation The WdfRequestGetInformation method returns completion status information for a specified I/O request. |
| WdfRequestGetIoQueue The WdfRequestGetIoQueue method returns a handle to the framework queue object from which a specified I/O request was delivered. |
| WdfRequestGetParameters The WdfRequestGetParameters method retrieves the parameters that are associated with a specified framework request object. |
| WdfRequestGetRequestorMode The WdfRequestGetRequestorMode method returns the processor access mode of the originator of a specified I/O request. |
| WdfRequestGetRequestorProcessId The WdfRequestGetRequestorProcessId method retrieves the identifier of the process that sent an I/O request. |
| WdfRequestGetStatus The WdfRequestGetStatus method returns the status of an I/O request. |
| WdfRequestGetUserModeDriverInitiatedIo The WdfRequestGetUserModeDriverInitiatedIo method determines whether an I/O request is marked as initiated by a UMDF driver. |
| WdfRequestImpersonate The WdfRequestImpersonate method registers a driver-supplied event callback function that the framework should call for impersonation. |
| WdfRequestIsCanceled The WdfRequestIsCanceled method determines whether the I/O manager has attempted to cancel a specified I/O request. |
| WdfRequestIsFrom32BitProcess The WdfRequestIsFrom32BitProcess method checks whether the originator of a specified I/O request is a 32-bit user-mode application. |
| WdfRequestIsFromUserModeDriver The WdfRequestIsFromUserModeDriver method indicates whether an I/O request came from a user-mode driver or an application. |
| WdfRequestIsReserved The WdfRequestIsReserved method determines whether a specified request object is one that the framework reserved to support guaranteed forward progress during low-memory situations. |
| WdfRequestMarkCancelable The WdfRequestMarkCancelable method enables cancellation of a specified I/O request. |
| WdfRequestMarkCancelableEx The WdfRequestMarkCancelableEx method enables cancellation of a specified I/O request. |
| WdfRequestProbeAndLockUserBufferForRead The WdfRequestProbeAndLockUserBufferForRead method verifies that an I/O request's user-mode buffer is readable, and then it locks the buffer's physical memory pages so drivers in the driver stack can read the buffer. |
| WdfRequestProbeAndLockUserBufferForWrite The WdfRequestProbeAndLockUserBufferForWrite method verifies that an I/O request's user-mode buffer is writeable, and then it locks the buffer's physical memory pages so drivers in the driver stack can write into the buffer. |
| WdfRequestRequeue The WdfRequestRequeue method returns an I/O request to the head of the I/O queue from which it was delivered to the driver. |
| WdfRequestRetrieveActivityId The WdfRequestRetrieveActivityId method retrieves the current activity identifier associated with an I/O request. |
| WdfRequestRetrieveInputBuffer The WdfRequestRetrieveInputBuffer method retrieves an I/O request's input buffer. |
| WdfRequestRetrieveInputMemory The WdfRequestRetrieveInputMemory method retrieves a handle to a framework memory object that represents an I/O request's input buffer. |
| WdfRequestRetrieveInputWdmMdl The WdfRequestRetrieveInputWdmMdl method retrieves a memory descriptor list (MDL) that represents an I/O request's input buffer. |
| WdfRequestRetrieveOutputBuffer The WdfRequestRetrieveOutputBuffer method retrieves an I/O request's output buffer. |
| WdfRequestRetrieveOutputMemory The WdfRequestRetrieveOutputMemory method retrieves a handle to a framework memory object that represents an I/O request's output buffer. |
| WdfRequestRetrieveOutputWdmMdl The WdfRequestRetrieveOutputWdmMdl method retrieves a memory descriptor list (MDL) that represents an I/O request's output buffer. |
| WdfRequestRetrieveUnsafeUserInputBuffer The WdfRequestRetrieveUnsafeUserInputBuffer method retrieves an I/O request's input buffer, if the request's technique for accessing data buffers is neither buffered nor direct I/O. |
| WdfRequestRetrieveUnsafeUserOutputBuffer The WdfRequestRetrieveUnsafeUserOutputBuffer method retrieves an I/O request's output buffer, if the request's technique for accessing data buffers is neither buffered nor direct I/O. |
| WdfRequestReuse The WdfRequestReuse method reinitializes a framework request object so that it can be reused. |
| WdfRequestSend The WdfRequestSend method sends a specified I/O request to a specified I/O target. |
| WdfRequestSetActivityId The WdfRequestSetActivityId method associates an activity identifier with an I/O request. |
| WdfRequestSetCompletionRoutine The WdfRequestSetCompletionRoutine method registers or deregisters a completion routine for the specified framework request object. |
| WdfRequestSetInformation The WdfRequestSetInformation method sets completion status information for a specified I/O request. |
| WdfRequestSetUserModeDriverInitiatedIo The WdfRequestSetUserModeDriverInitiatedIo method indicates to kernel-mode drivers that sit below the UMDF driver in the same device stack that a particular request should be treated as though it came from a UMDF driver. |
| WdfRequestStopAcknowledge The WdfRequestStopAcknowledge method informs the framework that the driver has stopped processing a specified I/O request. |
| WdfRequestUnmarkCancelable The WdfRequestUnmarkCancelable method disables cancellation of a specified I/O request. |
| WdfRequestWdmFormatUsingStackLocation The WdfRequestWdmFormatUsingStackLocation method formats an I/O request by copying the contents of a specified WDM I/O stack location structure to the next stack location in the request. |
| WdfRequestWdmGetIrp The WdfRequestWdmGetIrp method returns the WDM IRP structure that is associated with a specified framework request object. |
Callback functions
| EVT_WDF_REQUEST_CANCEL A driver's EvtRequestCancel event callback function handles operations that must be performed when an I/O request is canceled. |
| EVT_WDF_REQUEST_COMPLETION_ROUTINE A driver's CompletionRoutine event callback function executes when another driver completes a specified I/O request. |
| EVT_WDF_REQUEST_IMPERSONATE A driver's EvtRequestImpersonate event callback function performs tasks at the requested impersonation level, such as opening a protected file. |
Structures
| WDF_REQUEST_COMPLETION_PARAMS The WDF_REQUEST_COMPLETION_PARAMS structure contains parameters that are associated with the completion of an I/O request. |
| WDF_REQUEST_FORWARD_OPTIONS The WDF_REQUEST_FORWARD_OPTIONS structure contains options for requeuing an I/O request from a child device's I/O queue to the parent device's I/O queue. |
| WDF_REQUEST_PARAMETERS The WDF_REQUEST_PARAMETERS structure receives parameters that are associated with an I/O request. |
| WDF_REQUEST_REUSE_PARAMS The WDF_REQUEST_REUSE_PARAMS structure specifies information that is associated with a reused I/O request. |
| WDF_REQUEST_SEND_OPTIONS The WDF_REQUEST_SEND_OPTIONS structure specifies options that are associated with sending an I/O request to an I/O target. |
Enumerations
| WDF_REQUEST_FORWARD_OPTIONS_FLAGS The WDF_REQUEST_FORWARD_OPTIONS_FLAGS enumeration type defines flags that are used in a driver's WDF_REQUEST_FORWARD_OPTIONS structure. |
| WDF_REQUEST_REUSE_FLAGS The WDF_REQUEST_REUSE_FLAGS enumeration type defines flags that are used in a driver's WDF_REQUEST_REUSE_PARAMS structure. |
| WDF_REQUEST_SEND_OPTIONS_FLAGS The WDF_REQUEST_SEND_OPTIONS_FLAGS enumeration type defines flags that are used in a driver's WDF_REQUEST_SEND_OPTIONS structure. |
| WDF_REQUEST_STOP_ACTION_FLAGS The WDF_REQUEST_STOP_ACTION_FLAGS enumeration type defines flags that the framework passes to a driver's EvtIoStop callback function. |
| WDF_REQUEST_TYPE The WDF_REQUEST_TYPE enumeration type identifies types of requests that a framework request object might contain. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for