wdfrequest.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_WDF_REQUEST_PARAMETERS
struct	_WDF_REQUEST_COMPLETION_PARAMS
struct	_WDF_REQUEST_REUSE_PARAMS
struct	_WDF_REQUEST_SEND_OPTIONS
struct	_WDF_REQUEST_FORWARD_OPTIONS

Macros
#define	WDF_EXTERN_C
#define	WDF_EXTERN_C_START
#define	WDF_EXTERN_C_END

Typedefs
typedef WDF_EXTERN_C_START enum _WDF_REQUEST_REUSE_FLAGS	WDF_REQUEST_REUSE_FLAGS
typedef enum _WDF_REQUEST_STOP_ACTION_FLAGS	WDF_REQUEST_STOP_ACTION_FLAGS
typedef enum _WDF_REQUEST_SEND_OPTIONS_FLAGS	WDF_REQUEST_SEND_OPTIONS_FLAGS
typedef EVT_WDF_REQUEST_CANCEL *	PFN_WDF_REQUEST_CANCEL
typedef struct _WDF_REQUEST_PARAMETERS	WDF_REQUEST_PARAMETERS
typedef struct _WDF_REQUEST_PARAMETERS *	PWDF_REQUEST_PARAMETERS
typedef struct _WDF_USB_REQUEST_COMPLETION_PARAMS *	PWDF_USB_REQUEST_COMPLETION_PARAMS
typedef struct _WDF_REQUEST_COMPLETION_PARAMS	WDF_REQUEST_COMPLETION_PARAMS
typedef struct _WDF_REQUEST_COMPLETION_PARAMS *	PWDF_REQUEST_COMPLETION_PARAMS
typedef _In_ WDFIOTARGET	Target
typedef _In_ WDFIOTARGET _In_ PWDF_REQUEST_COMPLETION_PARAMS	Params
typedef _In_ WDFIOTARGET _In_ PWDF_REQUEST_COMPLETION_PARAMS _In_ WDFCONTEXT	Context
typedef EVT_WDF_REQUEST_COMPLETION_ROUTINE *	PFN_WDF_REQUEST_COMPLETION_ROUTINE
typedef struct _WDF_REQUEST_REUSE_PARAMS	WDF_REQUEST_REUSE_PARAMS
typedef struct _WDF_REQUEST_REUSE_PARAMS *	PWDF_REQUEST_REUSE_PARAMS
typedef struct _WDF_REQUEST_SEND_OPTIONS	WDF_REQUEST_SEND_OPTIONS
typedef struct _WDF_REQUEST_SEND_OPTIONS *	PWDF_REQUEST_SEND_OPTIONS
typedef enum _WDF_REQUEST_FORWARD_OPTIONS_FLAGS	WDF_REQUEST_FORWARD_OPTIONS_FLAGS
typedef struct _WDF_REQUEST_FORWARD_OPTIONS	WDF_REQUEST_FORWARD_OPTIONS
typedef struct _WDF_REQUEST_FORWARD_OPTIONS *	PWDF_REQUEST_FORWARD_OPTIONS
typedef _Must_inspect_result_	_IRQL_requires_max_(DISPATCH_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFREQUESTCREATE) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES	RequestAttributes
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_opt_ WDFIOTARGET	IoTarget
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_opt_ WDFIOTARGET _Out_ WDFREQUEST *	Request
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ PIRP	Irp
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ PIRP _In_ BOOLEAN	RequestFreesIrp
typedef _In_ WDFREQUEST _In_ PWDF_REQUEST_REUSE_PARAMS	ReuseParams
typedef _In_ WDFREQUEST _In_ PIO_STACK_LOCATION	Stack
typedef _Must_inspect_result_ WDFAPI BOOLEAN(STDCALL *	PFN_WDFREQUESTSEND) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals, _In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_opt_ PWDF_REQUEST_SEND_OPTIONS Options)
typedef _In_ WDFREQUEST _In_ PFN_WDF_REQUEST_CANCEL	EvtRequestCancel
typedef _In_ WDFREQUEST _In_opt_ PFN_WDF_REQUEST_COMPLETION_ROUTINE	CompletionRoutine = CompletionRoutine
typedef _In_ WDFREQUEST _In_opt_ PFN_WDF_REQUEST_COMPLETION_ROUTINE _In_opt_ __drv_aliasesMem WDFCONTEXT	CompletionContext
typedef _In_ WDFREQUEST _In_ NTSTATUS	Status
typedef _In_ WDFREQUEST _In_ NTSTATUS _In_ CCHAR	PriorityBoost
typedef _In_ WDFREQUEST _In_ NTSTATUS _In_ ULONG_PTR	Information
typedef _In_ WDFREQUEST _Out_ PWDF_REQUEST_PARAMETERS	Parameters
typedef _Must_inspect_result_ _In_ WDFREQUEST _Out_ WDFMEMORY *	Memory
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ size_t	MinimumRequiredLength
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Outptr_result_bytebuffer_ Length PVOID *	Buffer
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Outptr_result_bytebuffer_ Length PVOID _Out_opt_ size_t *	Length
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ size_t	MinimumRequiredSize
typedef _Must_inspect_result_ _In_ WDFREQUEST _Outptr_ PMDL *	Mdl
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Outptr_result_bytebuffer_maybenull_ Length PVOID *	InputBuffer
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Outptr_result_bytebuffer_maybenull_ Length PVOID *	OutputBuffer
typedef _Must_inspect_result_ _In_ WDFREQUEST	_In_reads_bytes_(Length) PVOID Buffer
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Out_ WDFMEMORY *	MemoryObject
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ WDFQUEUE	DestinationQueue
typedef _In_ WDFREQUEST _In_ BOOLEAN	Requeue
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ WDFQUEUE	ParentDeviceQueue
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ WDFQUEUE _In_ PWDF_REQUEST_FORWARD_OPTIONS	ForwardOptions

Enumerations
enum	_WDF_REQUEST_REUSE_FLAGS { WDF_REQUEST_REUSE_NO_FLAGS = 0x00000000 , WDF_REQUEST_REUSE_SET_NEW_IRP = 0x00000001 }
enum	_WDF_REQUEST_STOP_ACTION_FLAGS { WdfRequestStopActionInvalid = 0 , WdfRequestStopActionSuspend = 0x01 , WdfRequestStopActionPurge = 0x2 , WdfRequestStopRequestCancelable = 0x10000000 }
enum	_WDF_REQUEST_SEND_OPTIONS_FLAGS {   WDF_REQUEST_SEND_OPTION_TIMEOUT = 0x00000001 , WDF_REQUEST_SEND_OPTION_SYNCHRONOUS = 0x00000002 , WDF_REQUEST_SEND_OPTION_IGNORE_TARGET_STATE = 0x00000004 , WDF_REQUEST_SEND_OPTION_SEND_AND_FORGET = 0x00000008 ,   WDF_REQUEST_SEND_OPTION_IMPERSONATE_CLIENT = 0x00010000 , WDF_REQUEST_SEND_OPTION_IMPERSONATION_IGNORE_FAILURE = 0x00020000 }
enum	_WDF_REQUEST_FORWARD_OPTIONS_FLAGS { WDF_REQUEST_FORWARD_OPTION_SEND_AND_FORGET = 0x00000001 }

Functions
typedef	_Function_class_ (EVT_WDF_REQUEST_CANCEL) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_REQUEST_CANCEL(_In_ WDFREQUEST Request)
FORCEINLINE VOID	WDF_REQUEST_PARAMETERS_INIT (_Out_ PWDF_REQUEST_PARAMETERS Parameters)
FORCEINLINE VOID	WDF_REQUEST_COMPLETION_PARAMS_INIT (_Out_ PWDF_REQUEST_COMPLETION_PARAMS Params)
typedef	_Function_class_ (EVT_WDF_REQUEST_COMPLETION_ROUTINE) _IRQL_requires_same_ VOID STDCALL EVT_WDF_REQUEST_COMPLETION_ROUTINE(_In_ WDFREQUEST Request
FORCEINLINE VOID	WDF_REQUEST_REUSE_PARAMS_INIT (_Out_ PWDF_REQUEST_REUSE_PARAMS Params, _In_ ULONG Flags, _In_ NTSTATUS Status)
FORCEINLINE VOID	WDF_REQUEST_REUSE_PARAMS_SET_NEW_IRP (_Inout_ PWDF_REQUEST_REUSE_PARAMS Params, _In_ PIRP NewIrp)
FORCEINLINE VOID	WDF_REQUEST_SEND_OPTIONS_INIT (_Out_ PWDF_REQUEST_SEND_OPTIONS Options, _In_ ULONG Flags)
FORCEINLINE VOID	WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT (_Inout_ PWDF_REQUEST_SEND_OPTIONS Options, _In_ LONGLONG Timeout)
FORCEINLINE VOID	WDF_REQUEST_FORWARD_OPTIONS_INIT (_Out_ PWDF_REQUEST_FORWARD_OPTIONS ForwardOptions)
_Must_inspect_result_ FORCEINLINE BOOLEAN	WdfRequestSend (_In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_opt_ PWDF_REQUEST_SEND_OPTIONS Options)
_Must_inspect_result_	_IRQL_requires_max_ (APC_LEVEL) FORCEINLINE BOOLEAN WdfRequestIsFrom32BitProcess(_In_ WDFREQUEST Request)
	Probes and locks virtual pages in memory for the specified process.
_Must_inspect_result_	_IRQL_requires_max_ (PASSIVE_LEVEL) FORCEINLINE NTSTATUS WdfRequestRetrieveUnsafeUserInputBuffer(_In_ WDFREQUEST Request
	Queries information details about a security descriptor.

Macro Definition Documentation

WDF_EXTERN_C

#define WDF_EXTERN_C

Definition at line 40 of file wdfrequest.h.

WDF_EXTERN_C_END

#define WDF_EXTERN_C_END

Definition at line 42 of file wdfrequest.h.

WDF_EXTERN_C_START

#define WDF_EXTERN_C_START

Definition at line 41 of file wdfrequest.h.

Typedef Documentation

_In_reads_bytes_

typedef _Must_inspect_result_ _In_ WDFREQUEST _In_reads_bytes_(Length) PVOID Buffer

Definition at line 1467 of file wdfrequest.h.

_IRQL_requires_max_

typedef _Must_inspect_result_ _IRQL_requires_max_(DISPATCH_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFREQUESTFORWARDTOPARENTDEVICEIOQUEUE)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals

Definition at line 471 of file wdfrequest.h.

Buffer

_Must_inspect_result_ _In_ size_t _Outptr_result_bytebuffer_ Length PVOID* Buffer

Definition at line 1173 of file wdfrequest.h.

CompletionContext

_In_opt_ PFN_WDF_REQUEST_COMPLETION_ROUTINE _In_opt_ __drv_aliasesMem WDFCONTEXT CompletionContext

Initial value:

{
    ((PFN_WDFREQUESTSETCOMPLETIONROUTINE) WdfFunctions[WdfRequestSetCompletionRoutineTableIndex])(WdfDriverGlobals, Request, CompletionRoutine, CompletionContext)

Definition at line 897 of file wdfrequest.h.

CompletionRoutine

irpSp CompletionRoutine = CompletionRoutine

Definition at line 895 of file wdfrequest.h.

Context

typedef _In_ WDFIOTARGET _In_ PWDF_REQUEST_COMPLETION_PARAMS _In_ WDFCONTEXT Context

Definition at line 310 of file wdfrequest.h.

DestinationQueue

_Must_inspect_result_ _In_ WDFQUEUE DestinationQueue

Initial value:

{
    return ((PFN_WDFREQUESTFORWARDTOIOQUEUE) WdfFunctions[WdfRequestForwardToIoQueueTableIndex])(WdfDriverGlobals, Request, DestinationQueue)

Definition at line 1571 of file wdfrequest.h.

EvtRequestCancel

_Must_inspect_result_ _In_ WDFREQUEST _In_ PFN_WDF_REQUEST_CANCEL EvtRequestCancel

Initial value:

{
    ((PFN_WDFREQUESTMARKCANCELABLE) WdfFunctions[WdfRequestMarkCancelableTableIndex])(WdfDriverGlobals, Request, EvtRequestCancel)

Definition at line 729 of file wdfrequest.h.

ForwardOptions

_Must_inspect_result_ _In_ WDFQUEUE _In_ PWDF_REQUEST_FORWARD_OPTIONS ForwardOptions

Initial value:

{
    return ((PFN_WDFREQUESTFORWARDTOPARENTDEVICEIOQUEUE) WdfFunctions[WdfRequestForwardToParentDeviceIoQueueTableIndex])(WdfDriverGlobals, Request, ParentDeviceQueue, ForwardOptions)

Definition at line 1735 of file wdfrequest.h.

Information

_Must_inspect_result_ _In_ WDFUSBDEVICE _Out_ PWDF_USB_DEVICE_INFORMATION Information

Initial value:

{
    ((PFN_WDFREQUESTCOMPLETEWITHINFORMATION) WdfFunctions[WdfRequestCompleteWithInformationTableIndex])(WdfDriverGlobals, Request, Status, Information)

Definition at line 1048 of file wdfrequest.h.

InputBuffer

_Must_inspect_result_ _In_ size_t _Outptr_result_bytebuffer_maybenull_ Length PVOID* InputBuffer

Definition at line 1313 of file wdfrequest.h.

IoTarget

_Must_inspect_result_ _In_ WDFIOTARGET IoTarget

Initial value:

{
    return ((PFN_WDFREQUESTCHANGETARGET) WdfFunctions[WdfRequestChangeTargetTableIndex])(WdfDriverGlobals, Request, IoTarget)

Definition at line 480 of file wdfrequest.h.

Irp

_Must_inspect_result_ _In_ PIRP Irp

Definition at line 515 of file wdfrequest.h.

Length

_Must_inspect_result_ _In_ size_t Length

Initial value:

{
    return ((PFN_WDFREQUESTRETRIEVEINPUTBUFFER) WdfFunctions[WdfRequestRetrieveInputBufferTableIndex])(WdfDriverGlobals, Request, MinimumRequiredLength, Buffer, Length)

Definition at line 1175 of file wdfrequest.h.

Mdl

_Must_inspect_result_ _Outptr_ PMDL* Mdl

Initial value:

{
    return ((PFN_WDFREQUESTRETRIEVEINPUTWDMMDL) WdfFunctions[WdfRequestRetrieveInputWdmMdlTableIndex])(WdfDriverGlobals, Request, Mdl)

Definition at line 1249 of file wdfrequest.h.

Memory

_Must_inspect_result_ _Out_ WDFMEMORY* Memory

Initial value:

{
    return ((PFN_WDFREQUESTRETRIEVEINPUTMEMORY) WdfFunctions[WdfRequestRetrieveInputMemoryTableIndex])(WdfDriverGlobals, Request, Memory)

Definition at line 1109 of file wdfrequest.h.

MemoryObject

_Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Out_ WDFMEMORY * MemoryObject

Initial value:

{
    return ((PFN_WDFREQUESTPROBEANDLOCKUSERBUFFERFORREAD) WdfFunctions[WdfRequestProbeAndLockUserBufferForReadTableIndex])(WdfDriverGlobals, Request, Buffer, Length, MemoryObject)

Definition at line 1472 of file wdfrequest.h.

MinimumRequiredLength

_Must_inspect_result_ _In_ WDFREQUEST _In_ size_t MinimumRequiredLength

Definition at line 1171 of file wdfrequest.h.

MinimumRequiredSize

_Must_inspect_result_ _In_ size_t MinimumRequiredSize

Definition at line 1210 of file wdfrequest.h.

OutputBuffer

_Must_inspect_result_ _In_ size_t _Outptr_result_bytebuffer_maybenull_ Length PVOID* OutputBuffer

Definition at line 1352 of file wdfrequest.h.

Parameters

_Out_ PWDF_REQUEST_PARAMETERS Parameters

Initial value:

{
    ((PFN_WDFREQUESTGETPARAMETERS) WdfFunctions[WdfRequestGetParametersTableIndex])(WdfDriverGlobals, Request, Parameters)

Definition at line 1079 of file wdfrequest.h.

Params

_Must_inspect_result_ _In_ WDFUSBINTERFACE _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ PWDF_USB_INTERFACE_SELECT_SETTING_PARAMS Params

Initial value:

{
    ((PFN_WDFREQUESTGETCOMPLETIONPARAMS) WdfFunctions[WdfRequestGetCompletionParamsTableIndex])(WdfDriverGlobals, Request, Params)

Definition at line 308 of file wdfrequest.h.

ParentDeviceQueue

_Must_inspect_result_ _In_ WDFQUEUE ParentDeviceQueue

Definition at line 1733 of file wdfrequest.h.

PFN_WDF_REQUEST_CANCEL

typedef EVT_WDF_REQUEST_CANCEL* PFN_WDF_REQUEST_CANCEL

Definition at line 130 of file wdfrequest.h.

PFN_WDF_REQUEST_COMPLETION_ROUTINE

typedef EVT_WDF_REQUEST_COMPLETION_ROUTINE* PFN_WDF_REQUEST_COMPLETION_ROUTINE

Definition at line 313 of file wdfrequest.h.

PFN_WDFREQUESTSEND

typedef _Must_inspect_result_ WDFAPI BOOLEAN(STDCALL * PFN_WDFREQUESTSEND) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals, _In_ WDFREQUEST Request, _In_ WDFIOTARGET Target, _In_opt_ PWDF_REQUEST_SEND_OPTIONS Options)

Definition at line 661 of file wdfrequest.h.

PriorityBoost

_In_ CCHAR PriorityBoost

Initial value:

{
    ((PFN_WDFREQUESTCOMPLETEWITHPRIORITYBOOST) WdfFunctions[WdfRequestCompleteWithPriorityBoostTableIndex])(WdfDriverGlobals, Request, Status, PriorityBoost)

Definition at line 1015 of file wdfrequest.h.

PWDF_REQUEST_COMPLETION_PARAMS

typedef struct _WDF_REQUEST_COMPLETION_PARAMS * PWDF_REQUEST_COMPLETION_PARAMS

PWDF_REQUEST_FORWARD_OPTIONS

typedef struct _WDF_REQUEST_FORWARD_OPTIONS * PWDF_REQUEST_FORWARD_OPTIONS

PWDF_REQUEST_PARAMETERS

typedef struct _WDF_REQUEST_PARAMETERS * PWDF_REQUEST_PARAMETERS

PWDF_REQUEST_REUSE_PARAMS

typedef struct _WDF_REQUEST_REUSE_PARAMS * PWDF_REQUEST_REUSE_PARAMS

PWDF_REQUEST_SEND_OPTIONS

typedef struct _WDF_REQUEST_SEND_OPTIONS * PWDF_REQUEST_SEND_OPTIONS

PWDF_USB_REQUEST_COMPLETION_PARAMS

typedef struct _WDF_USB_REQUEST_COMPLETION_PARAMS* PWDF_USB_REQUEST_COMPLETION_PARAMS

Definition at line 220 of file wdfrequest.h.

Request

typedef _Must_inspect_result_ _In_ WDFREQUEST Request

Initial value:

{
    return ((PFN_WDFREQUESTCREATE) WdfFunctions[WdfRequestCreateTableIndex])(WdfDriverGlobals, RequestAttributes, IoTarget, Request)

Definition at line 482 of file wdfrequest.h.

RequestAttributes

typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES RequestAttributes

Definition at line 478 of file wdfrequest.h.

RequestFreesIrp

_Must_inspect_result_ _In_ PIRP _In_ BOOLEAN RequestFreesIrp

Definition at line 517 of file wdfrequest.h.

Requeue

_In_ BOOLEAN Requeue

Initial value:

{
    ((PFN_WDFREQUESTSTOPACKNOWLEDGE) WdfFunctions[WdfRequestStopAcknowledgeTableIndex])(WdfDriverGlobals, Request, Requeue)

Definition at line 1653 of file wdfrequest.h.

ReuseParams

_In_ PWDF_REQUEST_REUSE_PARAMS ReuseParams

Initial value:

{
    return ((PFN_WDFREQUESTREUSE) WdfFunctions[WdfRequestReuseTableIndex])(WdfDriverGlobals, Request, ReuseParams)

Definition at line 553 of file wdfrequest.h.

Stack

_In_ PIO_STACK_LOCATION Stack

Initial value:

{
    ((PFN_WDFREQUESTWDMFORMATUSINGSTACKLOCATION) WdfFunctions[WdfRequestWdmFormatUsingStackLocationTableIndex])(WdfDriverGlobals, Request, Stack)

Definition at line 638 of file wdfrequest.h.

Status

_In_ NTSTATUS Status

Initial value:

{
    ((PFN_WDFREQUESTCOMPLETE) WdfFunctions[WdfRequestCompleteTableIndex])(WdfDriverGlobals, Request, Status)

Definition at line 984 of file wdfrequest.h.

Target

_Must_inspect_result_ __in WDFREQUEST __in WDFIOTARGET Target

Definition at line 306 of file wdfrequest.h.

WDF_REQUEST_COMPLETION_PARAMS

typedef struct _WDF_REQUEST_COMPLETION_PARAMS WDF_REQUEST_COMPLETION_PARAMS

WDF_REQUEST_FORWARD_OPTIONS

typedef struct _WDF_REQUEST_FORWARD_OPTIONS WDF_REQUEST_FORWARD_OPTIONS

WDF_REQUEST_FORWARD_OPTIONS_FLAGS

typedef enum _WDF_REQUEST_FORWARD_OPTIONS_FLAGS WDF_REQUEST_FORWARD_OPTIONS_FLAGS

WDF_REQUEST_PARAMETERS

typedef struct _WDF_REQUEST_PARAMETERS WDF_REQUEST_PARAMETERS

WDF_REQUEST_REUSE_FLAGS

typedef WDF_EXTERN_C_START enum _WDF_REQUEST_REUSE_FLAGS WDF_REQUEST_REUSE_FLAGS

WDF_REQUEST_REUSE_PARAMS

typedef struct _WDF_REQUEST_REUSE_PARAMS WDF_REQUEST_REUSE_PARAMS

WDF_REQUEST_SEND_OPTIONS

typedef struct _WDF_REQUEST_SEND_OPTIONS WDF_REQUEST_SEND_OPTIONS

WDF_REQUEST_SEND_OPTIONS_FLAGS

typedef enum _WDF_REQUEST_SEND_OPTIONS_FLAGS WDF_REQUEST_SEND_OPTIONS_FLAGS

WDF_REQUEST_STOP_ACTION_FLAGS

typedef enum _WDF_REQUEST_STOP_ACTION_FLAGS WDF_REQUEST_STOP_ACTION_FLAGS

Enumeration Type Documentation

_WDF_REQUEST_FORWARD_OPTIONS_FLAGS

enum _WDF_REQUEST_FORWARD_OPTIONS_FLAGS

Enumerator
WDF_REQUEST_FORWARD_OPTION_SEND_AND_FORGET

Definition at line 430 of file wdfrequest.h.

                                                {
    WDF_REQUEST_FORWARD_OPTION_SEND_AND_FORGET = 0x00000001
} WDF_REQUEST_FORWARD_OPTIONS_FLAGS;

_WDF_REQUEST_REUSE_FLAGS

enum _WDF_REQUEST_REUSE_FLAGS

Enumerator
WDF_REQUEST_REUSE_NO_FLAGS
WDF_REQUEST_REUSE_SET_NEW_IRP

Definition at line 91 of file wdfrequest.h.

                                      {
    WDF_REQUEST_REUSE_NO_FLAGS = 0x00000000,
    WDF_REQUEST_REUSE_SET_NEW_IRP = 0x00000001,
} WDF_REQUEST_REUSE_FLAGS;

_WDF_REQUEST_SEND_OPTIONS_FLAGS

enum _WDF_REQUEST_SEND_OPTIONS_FLAGS

Enumerator
WDF_REQUEST_SEND_OPTION_TIMEOUT
WDF_REQUEST_SEND_OPTION_SYNCHRONOUS
WDF_REQUEST_SEND_OPTION_IGNORE_TARGET_STATE
WDF_REQUEST_SEND_OPTION_SEND_AND_FORGET
WDF_REQUEST_SEND_OPTION_IMPERSONATE_CLIENT
WDF_REQUEST_SEND_OPTION_IMPERSONATION_IGNORE_FAILURE

Definition at line 107 of file wdfrequest.h.

                                             {
    WDF_REQUEST_SEND_OPTION_TIMEOUT = 0x00000001,
    WDF_REQUEST_SEND_OPTION_SYNCHRONOUS = 0x00000002,
    WDF_REQUEST_SEND_OPTION_IGNORE_TARGET_STATE = 0x00000004,
    WDF_REQUEST_SEND_OPTION_SEND_AND_FORGET = 0x00000008,
    WDF_REQUEST_SEND_OPTION_IMPERSONATE_CLIENT = 0x00010000,
    WDF_REQUEST_SEND_OPTION_IMPERSONATION_IGNORE_FAILURE = 0x00020000,
} WDF_REQUEST_SEND_OPTIONS_FLAGS;

_WDF_REQUEST_STOP_ACTION_FLAGS

enum _WDF_REQUEST_STOP_ACTION_FLAGS

Enumerator
WdfRequestStopActionInvalid
WdfRequestStopActionSuspend
WdfRequestStopActionPurge
WdfRequestStopRequestCancelable

Definition at line 100 of file wdfrequest.h.

                                            {
    WdfRequestStopActionInvalid = 0,
    WdfRequestStopActionSuspend = 0x01, //  Device is being suspended
    WdfRequestStopActionPurge = 0x2, //  Device/queue is being removed
    WdfRequestStopRequestCancelable = 0x10000000, //  This bit is set if the request is marked cancelable
} WDF_REQUEST_STOP_ACTION_FLAGS;

Function Documentation

_Function_class_() [1/2]

typedef _Function_class_

(

EVT_WDF_REQUEST_CANCEL

)

_Function_class_() [2/2]

typedef _Function_class_

(

EVT_WDF_REQUEST_COMPLETION_ROUTINE

)

_IRQL_requires_max_() [1/2]

_Must_inspect_result_ _IRQL_requires_max_

(

APC_LEVEL

)

Probes and locks virtual pages in memory for the specified process.

Parameters

[in,out]	MemoryDescriptorList	Memory Descriptor List (MDL) containing the buffer to be probed and locked.
[in]	Process	The process for which the buffer should be probed and locked.
[in]	AccessMode	Access mode for probing the pages. Can be KernelMode or UserMode.
[in]	LockOperation	The type of the probing and locking operation. Can be IoReadAccess, IoWriteAccess or IoModifyAccess.

Returns

Nothing.

See also

MmProbeAndLockPages

Remarks

Must be called at IRQL <= APC_LEVEL

Probes and locks virtual pages in memory for the specified process.

Frees previously reserved amount of memory in system virtual address space.

Parameters

[in]	NumberOfBytes	Size, in bytes, of memory to reserve.
[in]	PoolTag	Pool Tag identifying the buffer. Usually consists from 4 characters in reversed order.

Returns

A pointer to the 1st memory block of the reserved buffer in case of success, NULL otherwise.

Remarks

Must be called at IRQL <= APC_LEVEL

Parameters

[in]	BaseAddress	A pointer to the 1st memory block of the reserved buffer.
[in]	PoolTag	Pool Tag identifying the buffer. Usually consists from 4 characters in reversed order.

Returns

Nothing.

See also

MmAllocateMappingAddress

Remarks

Must be called at IRQL <= APC_LEVEL

Definition at line 871 of file wdfrequest.h.

{
    return ((PFN_WDFREQUESTISFROM32BITPROCESS) WdfFunctions[WdfRequestIsFrom32BitProcessTableIndex])(WdfDriverGlobals, Request);
}

_IRQL_requires_max_() [2/2]

_Must_inspect_result_ _IRQL_requires_max_

(

PASSIVE_LEVEL

)

Queries information details about a security descriptor.

Computes the quota size of a security descriptor.

Assigns a security descriptor for a new object.

An extended function that assigns a security descriptor for a new object.

Frees a security descriptor.

An extended function that sets new information data to a security descriptor.

Modifies some information data about a security descriptor.

Parameters

[in]	SecurityInformation	Security information details to be queried from a security descriptor.
[out]	SecurityDescriptor	The returned security descriptor with security information data.
[in,out]	Length	The returned length of a security descriptor.
[in,out]	ObjectsSecurityDescriptor	The returned object security descriptor.

Returns

Returns STATUS_SUCCESS if the operations have been completed successfully and that the specific information about the security descriptor has been queried. STATUS_BUFFER_TOO_SMALL is returned if the buffer size is too small to contain the queried info about the security descriptor.

Parameters

[in]	Object	If specified, the function will use this arbitrary object that points to an object security descriptor.
[in]	SecurityInformation	Security information details to be set.
[in]	SecurityDescriptor	A security descriptor where its info is to be changed.
[in,out]	ObjectsSecurityDescriptor	The returned pointer to security descriptor objects.
[in]	PoolType	Pool type for the new security descriptor to allocate.
[in]	GenericMapping	The generic mapping of access rights masks.

Returns

See SeSetSecurityDescriptorInfoEx.

Parameters

[in]	Object	If specified, the function will use this arbitrary object that points to an object security descriptor.
[in]	SecurityInformation	Security information details to be set.
[in]	SecurityDescriptor	A security descriptor where its info is to be changed.
[in,out]	ObjectsSecurityDescriptor	The returned pointer to security descriptor objects.
[in]	AutoInheritFlags	Flags bitmask inheritation, influencing how the security descriptor can be inherited and if it can be in the first place.
[in]	PoolType	Pool type for the new security descriptor to allocate.
[in]	GenericMapping	The generic mapping of access rights masks.

Returns

Returns STATUS_SUCCESS if the operations have been completed without problems and that new info has been set to the security descriptor. STATUS_NO_SECURITY_ON_OBJECT is returned if the object does not have a security descriptor. STATUS_INSUFFICIENT_RESOURCES is returned if memory pool allocation for the new security descriptor with new info set has failed.

Parameters

[in]

SecurityDescriptor

A security descriptor to be freed from memory.

Returns

Returns STATUS_SUCCESS.

Parameters

[in]	_ParentDescriptor	A security descriptor of the parent object that is being created.
[in]	_ExplicitDescriptor	An explicit security descriptor that is applied to a new object.
[out]	NewDescriptor	The new allocated security descriptor.
[in]	ObjectType	The type of the new object.
[in]	IsDirectoryObject	Set this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]	AutoInheritFlags	Automatic inheritance flags that influence how access control entries within ACLs from security descriptors are inherited.
[in]	SubjectContext	Security subject context of the new object.
[in]	GenericMapping	Generic mapping of access mask rights.
[in]	PoolType	This parameter is unused.

Returns

Returns STATUS_SUCCESS if the operations have been completed successfully and that the security descriptor has been assigned to the new object. STATUS_NO_TOKEN is returned if the caller hasn't supplied a valid argument to a security subject context. STATUS_INVALID_OWNER is returned if the caller hasn't supplied a parent descriptor that belongs to the main user (owner). STATUS_INVALID_PRIMARY_GROUP is returned by the same reason as with the previous NTSTATUS code. The two NTSTATUS codes are returned if the calling thread stated that the owner and/or group is defaulted to the parent descriptor (SEF_DEFAULT_OWNER_FROM_PARENT and/or SEF_DEFAULT_GROUP_FROM_PARENT respectively). STATUS_INSUFFICIENT_RESOURCES is returned if memory pool allocation for the descriptor buffer has failed. A failure NTSTATUS is returned otherwise.

Parameters

[in]	ParentDescriptor	A security descriptor of the parent object that is being created.
[in]	ExplicitDescriptor	An explicit security descriptor that is applied to a new object.
[out]	NewDescriptor	The new allocated security descriptor.
[in]	IsDirectoryObject	Set this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]	SubjectContext	Security subject context of the new object.
[in]	GenericMapping	Generic mapping of access mask rights.
[in]	PoolType	This parameter is unused.

Returns

See SeAssignSecurityEx.

Parameters

[in]	SecurityDescriptor	A security descriptor.
[out]	QuotaInfoSize	The returned quota size of the given security descriptor to the caller. The function may return 0 to this parameter if the descriptor doesn't have a group or a discretionary access control list (DACL) even.

Returns

Returns STATUS_SUCCESS if the quota size of a security descriptor has been computed successfully. STATUS_UNKNOWN_REVISION is returned if the security descriptor has an invalid revision.

Definition at line 923 of file Messaging.c.

{
    PFLT_SERVER_PORT_OBJECT PortObject;
    NTSTATUS Status;
 
    /* The caller must allow at least one connection */
    if (MaxConnections == 0)
    {
        return STATUS_INVALID_PARAMETER;
    }
 
    /* The request must be for a kernel handle */
    if (!(ObjectAttributes->Attributes & OBJ_KERNEL_HANDLE))
    {
        return STATUS_INVALID_PARAMETER;
    }
 
    /*
     * Get rundown protection on the target to stop the owner
     * from unloading whilst this port object is open. It gets
     * removed in the FltpServerPortClose callback
     */
    Status = FltObjectReference(Filter);
    if (!NT_SUCCESS(Status))
    {
        return Status;
    }
 
    /* Create the server port object for this filter */
    Status = ObCreateObject(KernelMode,
                            ServerPortObjectType,
                            ObjectAttributes,
                            KernelMode,
                            NULL,
                            sizeof(FLT_SERVER_PORT_OBJECT),
                            0,
                            0,
                            (PVOID *)&PortObject);
    if (NT_SUCCESS(Status))
    {
        /* Zero out the struct */
        RtlZeroMemory(PortObject, sizeof(FLT_SERVER_PORT_OBJECT));
 
        /* Increment the ref count on the target filter */
        FltpObjectPointerReference((PFLT_OBJECT)Filter);
 
        /* Setup the filter port object */
        PortObject->Filter = Filter;
        PortObject->ConnectNotify = ConnectNotifyCallback;
        PortObject->DisconnectNotify = DisconnectNotifyCallback;
        PortObject->MessageNotify = MessageNotifyCallback;
        PortObject->Cookie = ServerPortCookie;
        PortObject->MaxConnections = MaxConnections;
 
        /* Insert the object */
        Status = ObInsertObject(PortObject,
                                NULL,
                                STANDARD_RIGHTS_ALL | FILE_READ_DATA,
                                0,
                                NULL,
                                (PHANDLE)ServerPort);
        if (NT_SUCCESS(Status))
        {
            /* Lock the connection list */
            ExAcquireFastMutex(&Filter->ConnectionList.mLock);
 
            /* Add the new port object to the connection list and increment the count */
            InsertTailList(&Filter->ConnectionList.mList, &PortObject->FilterLink);
            Filter->ConnectionList.mCount++;
 
            /* Unlock the connection list*/
            ExReleaseFastMutex(&Filter->ConnectionList.mLock);
        }
    }
 
    if (!NT_SUCCESS(Status))
    {
        /* Allow the filter to be cleaned up */
        FltObjectDereference(Filter);
    }
 
    return Status;
}

WDF_REQUEST_COMPLETION_PARAMS_INIT()

FORCEINLINE VOID WDF_REQUEST_COMPLETION_PARAMS_INIT

(

_Out_ PWDF_REQUEST_COMPLETION_PARAMS

Params

)

Definition at line 288 of file wdfrequest.h.

{
    RtlZeroMemory(Params, sizeof(WDF_REQUEST_COMPLETION_PARAMS));
    Params->Size = sizeof(WDF_REQUEST_COMPLETION_PARAMS);
    Params->Type = WdfRequestTypeNoFormat;
}

Referenced by FxRequest::CopyCompletionParams(), and FxRequestContext::InitCompletionParams().

WDF_REQUEST_FORWARD_OPTIONS_INIT()

FORCEINLINE VOID WDF_REQUEST_FORWARD_OPTIONS_INIT

(

_Out_ PWDF_REQUEST_FORWARD_OPTIONS

ForwardOptions

)

Definition at line 453 of file wdfrequest.h.

{
    RtlZeroMemory(ForwardOptions, sizeof(WDF_REQUEST_FORWARD_OPTIONS));
 
    ForwardOptions->Size = sizeof(WDF_REQUEST_FORWARD_OPTIONS);
    ForwardOptions->Flags |= WDF_REQUEST_FORWARD_OPTION_SEND_AND_FORGET;
}

WDF_REQUEST_PARAMETERS_INIT()

FORCEINLINE VOID WDF_REQUEST_PARAMETERS_INIT

(

_Out_ PWDF_REQUEST_PARAMETERS

Parameters

)

Definition at line 211 of file wdfrequest.h.

{
    RtlZeroMemory(Parameters, sizeof(WDF_REQUEST_PARAMETERS));
 
    Parameters->Size = sizeof(WDF_REQUEST_PARAMETERS);
}

Referenced by DeviceEvtIoInCallerContext(), ReadWriteWorkItemRoutine(), RequestCompletion(), RequestHandleQueryPropertyDeviceUniqueId(), RequestHandleQueryPropertyWriteCache(), RequestIsIoctlBlockedByExclusiveAccess(), RequestSynchronizeProcessWithSerialQueue(), SequentialQueueEvtIoDeviceControl(), and SequentialQueueEvtIoReadWrite().

WDF_REQUEST_REUSE_PARAMS_INIT()

FORCEINLINE VOID WDF_REQUEST_REUSE_PARAMS_INIT	(	_Out_ PWDF_REQUEST_REUSE_PARAMS	Params,
		_In_ ULONG	Flags,
		_In_ NTSTATUS	Status
	)

Definition at line 364 of file wdfrequest.h.

{
    RtlZeroMemory(Params, sizeof(WDF_REQUEST_REUSE_PARAMS));
 
    Params->Size = sizeof(WDF_REQUEST_REUSE_PARAMS);
    Params->Flags = Flags;
    Params->Status = Status;
}

Referenced by _IRQL_requires_max_(), DeviceReleaseQueueCompletion(), FxUsbPipeContinuousReader::FormatRepeater(), and ScratchBuffer_ResetItems().

WDF_REQUEST_REUSE_PARAMS_SET_NEW_IRP()

FORCEINLINE VOID WDF_REQUEST_REUSE_PARAMS_SET_NEW_IRP	(	_Inout_ PWDF_REQUEST_REUSE_PARAMS	Params,
		_In_ PIRP	NewIrp
	)

Definition at line 379 of file wdfrequest.h.

{
    Params->Flags |= WDF_REQUEST_REUSE_SET_NEW_IRP;
    Params->NewIrp = NewIrp;
}

WDF_REQUEST_SEND_OPTIONS_INIT()

FORCEINLINE VOID WDF_REQUEST_SEND_OPTIONS_INIT	(	_Out_ PWDF_REQUEST_SEND_OPTIONS	Options,
		_In_ ULONG	Flags
	)

Definition at line 409 of file wdfrequest.h.

{
    RtlZeroMemory(Options, sizeof(WDF_REQUEST_SEND_OPTIONS));
    Options->Size = sizeof(WDF_REQUEST_SEND_OPTIONS);
    Options->Flags = Flags;
}

Referenced by FxUsbDevice::Deconfig(), FxUsbDevice::GetPortStatus(), FxUsbDevice::GetString(), FxUsbDevice::InitDevice(), RequestSend(), FxUsbDevice::SelectConfig(), FxUsbInterface::SelectSetting(), FxUsbDevice::SendSyncRequest(), FxUsbDevice::SendSyncUmUrb(), and FxIoTarget::SubmitSyncRequestIgnoreTargetState().

WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT()

FORCEINLINE VOID WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT	(	_Inout_ PWDF_REQUEST_SEND_OPTIONS	Options,
		_In_ LONGLONG	Timeout
	)

Definition at line 421 of file wdfrequest.h.

{
    Options->Flags |= WDF_REQUEST_SEND_OPTION_TIMEOUT;
    Options->Timeout = Timeout;
}

Referenced by FxUsbDevice::GetString(), FxUsbDevice::InitDevice(), FxUsbDevice::SelectConfig(), FxUsbInterface::SelectSetting(), FxUsbDevice::SendSyncRequest(), and FxUsbDevice::SendSyncUmUrb().

WdfRequestSend()

_Must_inspect_result_ FORCEINLINE BOOLEAN WdfRequestSend	(	_In_ WDFREQUEST	Request,
		_In_ WDFIOTARGET	Target,
		_In_opt_ PWDF_REQUEST_SEND_OPTIONS	Options
	)

Definition at line 677 of file wdfrequest.h.

{
    return ((PFN_WDFREQUESTSEND) WdfFunctions[WdfRequestSendTableIndex])(WdfDriverGlobals, Request, Target, Options);
}

Referenced by RequestSend().