ReactOS 0.4.15-dev-7906-g1b85a5f
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_PARAMETERSPWDF_REQUEST_PARAMETERS
 
typedef struct _WDF_USB_REQUEST_COMPLETION_PARAMSPWDF_USB_REQUEST_COMPLETION_PARAMS
 
typedef struct _WDF_REQUEST_COMPLETION_PARAMS WDF_REQUEST_COMPLETION_PARAMS
 
typedef struct _WDF_REQUEST_COMPLETION_PARAMSPWDF_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_PARAMSPWDF_REQUEST_REUSE_PARAMS
 
typedef struct _WDF_REQUEST_SEND_OPTIONS WDF_REQUEST_SEND_OPTIONS
 
typedef struct _WDF_REQUEST_SEND_OPTIONSPWDF_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_OPTIONSPWDF_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(STDCALLPFN_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 PVOIDBuffer
 
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Outptr_result_bytebuffer_ Length PVOID _Out_opt_ size_tLength
 
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ size_t MinimumRequiredSize
 
typedef _Must_inspect_result_ _In_ WDFREQUEST _Outptr_ PMDLMdl
 
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Outptr_result_bytebuffer_maybenull_ Length PVOIDInputBuffer
 
typedef _Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Outptr_result_bytebuffer_maybenull_ Length PVOIDOutputBuffer
 
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)
 
_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

◆ CompletionContext

Initial value:
{
#define WdfFunctions
Definition: wdf.h:66
PWDF_DRIVER_GLOBALS WdfDriverGlobals
@ WdfRequestSetCompletionRoutineTableIndex
Definition: wdffuncenum.h:285
_In_ WDFREQUEST _In_opt_ PFN_WDF_REQUEST_COMPLETION_ROUTINE _In_opt_ __drv_aliasesMem WDFCONTEXT CompletionContext
Definition: wdfrequest.h:898
_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_opt_ WDFIOTARGET _Out_ WDFREQUEST * Request
Definition: wdfrequest.h:483
_In_ WDFREQUEST _In_opt_ PFN_WDF_REQUEST_COMPLETION_ROUTINE CompletionRoutine
Definition: wdfrequest.h:895

Definition at line 897 of file wdfrequest.h.

◆ CompletionRoutine

Definition at line 895 of file wdfrequest.h.

◆ Context

Definition at line 310 of file wdfrequest.h.

◆ DestinationQueue

Initial value:
{
@ WdfRequestForwardToIoQueueTableIndex
Definition: wdffuncenum.h:306
_Must_inspect_result_ _In_ WDFREQUEST _In_ WDFQUEUE DestinationQueue
Definition: wdfrequest.h:1572

Definition at line 1571 of file wdfrequest.h.

◆ EvtRequestCancel

Initial value:
{
@ WdfRequestMarkCancelableTableIndex
Definition: wdffuncenum.h:280
_In_ WDFREQUEST _In_ PFN_WDF_REQUEST_CANCEL EvtRequestCancel
Definition: wdfrequest.h:730

Definition at line 729 of file wdfrequest.h.

◆ ForwardOptions

Initial value:
{
@ WdfRequestForwardToParentDeviceIoQueueTableIndex
Definition: wdffuncenum.h:420
_Must_inspect_result_ _In_ WDFREQUEST _In_ WDFQUEUE _In_ PWDF_REQUEST_FORWARD_OPTIONS ForwardOptions
Definition: wdfrequest.h:1736
_Must_inspect_result_ _In_ WDFREQUEST _In_ WDFQUEUE ParentDeviceQueue
Definition: wdfrequest.h:1733

Definition at line 1735 of file wdfrequest.h.

◆ Information

Initial value:
{
@ WdfRequestCompleteWithInformationTableIndex
Definition: wdffuncenum.h:290
_In_ WDFREQUEST _In_ NTSTATUS Status
Definition: wdfrequest.h:985
_In_ WDFREQUEST _In_ NTSTATUS _In_ ULONG_PTR Information
Definition: wdfrequest.h:1049

Definition at line 1048 of file wdfrequest.h.

◆ InputBuffer

◆ IoTarget

Initial value:
{
@ WdfRequestChangeTargetTableIndex
Definition: wdffuncenum.h:275
_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_opt_ WDFIOTARGET IoTarget
Definition: wdfrequest.h:480

Definition at line 480 of file wdfrequest.h.

◆ Irp

Definition at line 515 of file wdfrequest.h.

◆ Length

Initial value:
{
@ WdfRequestRetrieveInputBufferTableIndex
Definition: wdffuncenum.h:294
_Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Outptr_result_bytebuffer_ Length PVOID _Out_opt_ size_t * Length
Definition: wdfrequest.h:1176
_Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Outptr_result_bytebuffer_ Length PVOID * Buffer
Definition: wdfrequest.h:1172
_Must_inspect_result_ _In_ WDFREQUEST _In_ size_t MinimumRequiredLength
Definition: wdfrequest.h:1171

Definition at line 1175 of file wdfrequest.h.

◆ Mdl

Initial value:
{
return ((PFN_WDFREQUESTRETRIEVEINPUTWDMMDL) WdfFunctions[WdfRequestRetrieveInputWdmMdlTableIndex])(WdfDriverGlobals, Request, Mdl)
@ WdfRequestRetrieveInputWdmMdlTableIndex
Definition: wdffuncenum.h:296
_Must_inspect_result_ _In_ WDFREQUEST _Outptr_ PMDL * Mdl
Definition: wdfrequest.h:1250

Definition at line 1249 of file wdfrequest.h.

◆ Memory

Initial value:
{
return ((PFN_WDFREQUESTRETRIEVEINPUTMEMORY) WdfFunctions[WdfRequestRetrieveInputMemoryTableIndex])(WdfDriverGlobals, Request, Memory)
@ WdfRequestRetrieveInputMemoryTableIndex
Definition: wdffuncenum.h:292
_Must_inspect_result_ _In_ WDFREQUEST _Out_ WDFMEMORY * Memory
Definition: wdfrequest.h:1110

Definition at line 1109 of file wdfrequest.h.

◆ MemoryObject

Initial value:
{
@ WdfRequestProbeAndLockUserBufferForReadTableIndex
Definition: wdffuncenum.h:303
_Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Out_ WDFMEMORY * MemoryObject
Definition: wdfrequest.h:1473

Definition at line 1472 of file wdfrequest.h.

◆ MinimumRequiredLength

◆ MinimumRequiredSize

◆ OutputBuffer

◆ Parameters

Initial value:
{
@ WdfRequestGetParametersTableIndex
Definition: wdffuncenum.h:291
_In_ WDFREQUEST _Out_ PWDF_REQUEST_PARAMETERS Parameters
Definition: wdfrequest.h:1080

Definition at line 1079 of file wdfrequest.h.

◆ Params

Initial value:
{
@ WdfRequestGetCompletionParamsTableIndex
Definition: wdffuncenum.h:286
_In_ WDFIOTARGET _In_ PWDF_REQUEST_COMPLETION_PARAMS Params
Definition: wdfrequest.h:308

Definition at line 308 of file wdfrequest.h.

◆ 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

Definition at line 661 of file wdfrequest.h.

◆ PriorityBoost

Initial value:
{
@ WdfRequestCompleteWithPriorityBoostTableIndex
Definition: wdffuncenum.h:289
_In_ WDFREQUEST _In_ NTSTATUS _In_ CCHAR PriorityBoost
Definition: wdfrequest.h:1016

Definition at line 1015 of file wdfrequest.h.

◆ PWDF_REQUEST_COMPLETION_PARAMS

◆ PWDF_REQUEST_FORWARD_OPTIONS

◆ PWDF_REQUEST_PARAMETERS

◆ PWDF_REQUEST_REUSE_PARAMS

◆ PWDF_REQUEST_SEND_OPTIONS

◆ PWDF_USB_REQUEST_COMPLETION_PARAMS

◆ Request

typedef _Must_inspect_result_ _In_ WDFREQUEST Request
Initial value:
{
@ WdfRequestCreateTableIndex
Definition: wdffuncenum.h:272
_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES RequestAttributes
Definition: wdfrequest.h:478

Definition at line 482 of file wdfrequest.h.

◆ RequestAttributes

◆ RequestFreesIrp

◆ Requeue

Initial value:
{
@ WdfRequestStopAcknowledgeTableIndex
Definition: wdffuncenum.h:309
_In_ WDFREQUEST _In_ BOOLEAN Requeue
Definition: wdfrequest.h:1654

Definition at line 1653 of file wdfrequest.h.

◆ ReuseParams

Initial value:
{
@ WdfRequestReuseTableIndex
Definition: wdffuncenum.h:274
_In_ WDFREQUEST _In_ PWDF_REQUEST_REUSE_PARAMS ReuseParams
Definition: wdfrequest.h:554

Definition at line 553 of file wdfrequest.h.

◆ Stack

Initial value:
{
@ WdfRequestWdmFormatUsingStackLocationTableIndex
Definition: wdffuncenum.h:277
_In_ WDFREQUEST _In_ PIO_STACK_LOCATION Stack
Definition: wdfrequest.h:639

Definition at line 638 of file wdfrequest.h.

◆ Status

Initial value:
{
@ WdfRequestCompleteTableIndex
Definition: wdffuncenum.h:288

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

◆ WDF_REQUEST_FORWARD_OPTIONS

◆ WDF_REQUEST_FORWARD_OPTIONS_FLAGS

◆ WDF_REQUEST_PARAMETERS

◆ WDF_REQUEST_REUSE_FLAGS

◆ WDF_REQUEST_REUSE_PARAMS

◆ WDF_REQUEST_SEND_OPTIONS

◆ WDF_REQUEST_SEND_OPTIONS_FLAGS

◆ WDF_REQUEST_STOP_ACTION_FLAGS

Enumeration Type Documentation

◆ _WDF_REQUEST_FORWARD_OPTIONS_FLAGS

Enumerator
WDF_REQUEST_FORWARD_OPTION_SEND_AND_FORGET 

Definition at line 430 of file wdfrequest.h.

430 {
@ WDF_REQUEST_FORWARD_OPTION_SEND_AND_FORGET
Definition: wdfrequest.h:431
enum _WDF_REQUEST_FORWARD_OPTIONS_FLAGS WDF_REQUEST_FORWARD_OPTIONS_FLAGS

◆ _WDF_REQUEST_REUSE_FLAGS

Enumerator
WDF_REQUEST_REUSE_NO_FLAGS 
WDF_REQUEST_REUSE_SET_NEW_IRP 

Definition at line 91 of file wdfrequest.h.

91 {
92 WDF_REQUEST_REUSE_NO_FLAGS = 0x00000000,
WDF_EXTERN_C_START enum _WDF_REQUEST_REUSE_FLAGS WDF_REQUEST_REUSE_FLAGS
@ WDF_REQUEST_REUSE_SET_NEW_IRP
Definition: wdfrequest.h:93
@ WDF_REQUEST_REUSE_NO_FLAGS
Definition: wdfrequest.h:92

◆ _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.

107 {
@ WDF_REQUEST_SEND_OPTION_IMPERSONATE_CLIENT
Definition: wdfrequest.h:112
@ WDF_REQUEST_SEND_OPTION_SEND_AND_FORGET
Definition: wdfrequest.h:111
@ WDF_REQUEST_SEND_OPTION_IMPERSONATION_IGNORE_FAILURE
Definition: wdfrequest.h:113
@ WDF_REQUEST_SEND_OPTION_TIMEOUT
Definition: wdfrequest.h:108
@ WDF_REQUEST_SEND_OPTION_IGNORE_TARGET_STATE
Definition: wdfrequest.h:110
@ WDF_REQUEST_SEND_OPTION_SYNCHRONOUS
Definition: wdfrequest.h:109
enum _WDF_REQUEST_SEND_OPTIONS_FLAGS WDF_REQUEST_SEND_OPTIONS_FLAGS

◆ _WDF_REQUEST_STOP_ACTION_FLAGS

Enumerator
WdfRequestStopActionInvalid 
WdfRequestStopActionSuspend 
WdfRequestStopActionPurge 
WdfRequestStopRequestCancelable 

Definition at line 100 of file wdfrequest.h.

100 {
102 WdfRequestStopActionSuspend = 0x01, // Device is being suspended
103 WdfRequestStopActionPurge = 0x2, // Device/queue is being removed
104 WdfRequestStopRequestCancelable = 0x10000000, // This bit is set if the request is marked cancelable
@ WdfRequestStopRequestCancelable
Definition: wdfrequest.h:104
@ WdfRequestStopActionInvalid
Definition: wdfrequest.h:101
@ WdfRequestStopActionSuspend
Definition: wdfrequest.h:102
@ WdfRequestStopActionPurge
Definition: wdfrequest.h:103
enum _WDF_REQUEST_STOP_ACTION_FLAGS 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  )

Definition at line 871 of file wdfrequest.h.

878{
879 return ((PFN_WDFREQUESTISFROM32BITPROCESS) WdfFunctions[WdfRequestIsFrom32BitProcessTableIndex])(WdfDriverGlobals, Request);
880}
@ WdfRequestIsFrom32BitProcessTableIndex
Definition: wdffuncenum.h:284

◆ _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]SecurityInformationSecurity information details to be queried from a security descriptor.
[out]SecurityDescriptorThe returned security descriptor with security information data.
[in,out]LengthThe returned length of a security descriptor.
[in,out]ObjectsSecurityDescriptorThe 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]ObjectIf specified, the function will use this arbitrary object that points to an object security descriptor.
[in]SecurityInformationSecurity information details to be set.
[in]SecurityDescriptorA security descriptor where its info is to be changed.
[in,out]ObjectsSecurityDescriptorThe returned pointer to security descriptor objects.
[in]PoolTypePool type for the new security descriptor to allocate.
[in]GenericMappingThe generic mapping of access rights masks.
Returns
See SeSetSecurityDescriptorInfoEx.
Parameters
[in]ObjectIf specified, the function will use this arbitrary object that points to an object security descriptor.
[in]SecurityInformationSecurity information details to be set.
[in]SecurityDescriptorA security descriptor where its info is to be changed.
[in,out]ObjectsSecurityDescriptorThe returned pointer to security descriptor objects.
[in]AutoInheritFlagsFlags bitmask inheritation, influencing how the security descriptor can be inherited and if it can be in the first place.
[in]PoolTypePool type for the new security descriptor to allocate.
[in]GenericMappingThe 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]SecurityDescriptorA security descriptor to be freed from memory.
Returns
Returns STATUS_SUCCESS.
Parameters
[in]_ParentDescriptorA security descriptor of the parent object that is being created.
[in]_ExplicitDescriptorAn explicit security descriptor that is applied to a new object.
[out]NewDescriptorThe new allocated security descriptor.
[in]ObjectTypeThe type of the new object.
[in]IsDirectoryObjectSet this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]AutoInheritFlagsAutomatic inheritance flags that influence how access control entries within ACLs from security descriptors are inherited.
[in]SubjectContextSecurity subject context of the new object.
[in]GenericMappingGeneric mapping of access mask rights.
[in]PoolTypeThis 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]ParentDescriptorA security descriptor of the parent object that is being created.
[in]ExplicitDescriptorAn explicit security descriptor that is applied to a new object.
[out]NewDescriptorThe new allocated security descriptor.
[in]IsDirectoryObjectSet this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]SubjectContextSecurity subject context of the new object.
[in]GenericMappingGeneric mapping of access mask rights.
[in]PoolTypeThis parameter is unused.
Returns
See SeAssignSecurityEx.
Parameters
[in]SecurityDescriptorA security descriptor.
[out]QuotaInfoSizeThe 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.

75{
76 PFLT_SERVER_PORT_OBJECT PortObject;
78
79 /* The caller must allow at least one connection */
80 if (MaxConnections == 0)
81 {
83 }
84
85 /* The request must be for a kernel handle */
86 if (!(ObjectAttributes->Attributes & OBJ_KERNEL_HANDLE))
87 {
89 }
90
91 /*
92 * Get rundown protection on the target to stop the owner
93 * from unloading whilst this port object is open. It gets
94 * removed in the FltpServerPortClose callback
95 */
97 if (!NT_SUCCESS(Status))
98 {
99 return Status;
100 }
101
102 /* Create the server port object for this filter */
107 NULL,
109 0,
110 0,
111 (PVOID *)&PortObject);
112 if (NT_SUCCESS(Status))
113 {
114 /* Zero out the struct */
115 RtlZeroMemory(PortObject, sizeof(FLT_SERVER_PORT_OBJECT));
116
117 /* Increment the ref count on the target filter */
119
120 /* Setup the filter port object */
121 PortObject->Filter = Filter;
125 PortObject->Cookie = ServerPortCookie;
126 PortObject->MaxConnections = MaxConnections;
127
128 /* Insert the object */
129 Status = ObInsertObject(PortObject,
130 NULL,
132 0,
133 NULL,
135 if (NT_SUCCESS(Status))
136 {
137 /* Lock the connection list */
139
140 /* Add the new port object to the connection list and increment the count */
143
144 /* Unlock the connection list*/
146 }
147 }
148
149 if (!NT_SUCCESS(Status))
150 {
151 /* Allow the filter to be cleaned up */
153 }
154
155 return Status;
156}
static const INTERNET_PORT ServerPort
Definition: CWebService.cpp:11
POBJECT_TYPE ServerPortObjectType
Definition: Messaging.c:24
VOID FLTAPI FltObjectDereference(_Inout_ PVOID Object)
Definition: Object.c:53
NTSTATUS FLTAPI FltObjectReference(_Inout_ PVOID Object)
Definition: Object.c:41
LONG NTSTATUS
Definition: precomp.h:26
IN PUNICODE_STRING IN POBJECT_ATTRIBUTES ObjectAttributes
Definition: conport.c:36
#define NULL
Definition: types.h:112
#define NT_SUCCESS(StatCode)
Definition: apphelp.c:32
#define InsertTailList(ListHead, Entry)
_Must_inspect_result_ _In_opt_ PFLT_FILTER Filter
Definition: fltkernel.h:1801
_Must_inspect_result_ _Outptr_ PFLT_PORT _In_ POBJECT_ATTRIBUTES _In_opt_ PVOID _In_ PFLT_CONNECT_NOTIFY _In_ PFLT_DISCONNECT_NOTIFY _In_opt_ PFLT_MESSAGE_NOTIFY MessageNotifyCallback
Definition: fltkernel.h:1877
_Must_inspect_result_ _Outptr_ PFLT_PORT _In_ POBJECT_ATTRIBUTES _In_opt_ PVOID _In_ PFLT_CONNECT_NOTIFY ConnectNotifyCallback
Definition: fltkernel.h:1875
_Must_inspect_result_ _Outptr_ PFLT_PORT _In_ POBJECT_ATTRIBUTES _In_opt_ PVOID ServerPortCookie
Definition: fltkernel.h:1874
_Must_inspect_result_ _Outptr_ PFLT_PORT _In_ POBJECT_ATTRIBUTES _In_opt_ PVOID _In_ PFLT_CONNECT_NOTIFY _In_ PFLT_DISCONNECT_NOTIFY DisconnectNotifyCallback
Definition: fltkernel.h:1876
ULONG FltpObjectPointerReference(_In_ PFLT_OBJECT Object)
Definition: Object.c:322
Status
Definition: gdiplustypes.h:25
VOID FASTCALL ExAcquireFastMutex(IN PFAST_MUTEX FastMutex)
Definition: fmutex.c:23
VOID FASTCALL ExReleaseFastMutex(IN PFAST_MUTEX FastMutex)
Definition: fmutex.c:31
#define OBJ_KERNEL_HANDLE
Definition: winternl.h:231
static LONG MaxConnections
#define KernelMode
Definition: asm.h:34
#define FILE_READ_DATA
Definition: nt_native.h:628
#define STANDARD_RIGHTS_ALL
Definition: nt_native.h:69
PVOID *typedef PHANDLE
Definition: ntsecpkg.h:455
NTSTATUS NTAPI ObInsertObject(IN PVOID Object, IN PACCESS_STATE AccessState OPTIONAL, IN ACCESS_MASK DesiredAccess, IN ULONG ObjectPointerBias, OUT PVOID *NewObject OPTIONAL, OUT PHANDLE Handle)
Definition: obhandle.c:2935
NTSTATUS NTAPI ObCreateObject(IN KPROCESSOR_MODE ProbeMode OPTIONAL, IN POBJECT_TYPE Type, IN POBJECT_ATTRIBUTES ObjectAttributes OPTIONAL, IN KPROCESSOR_MODE AccessMode, IN OUT PVOID ParseContext OPTIONAL, IN ULONG ObjectSize, IN ULONG PagedPoolCharge OPTIONAL, IN ULONG NonPagedPoolCharge OPTIONAL, OUT PVOID *Object)
Definition: oblife.c:1039
FLT_MUTEX_LIST_HEAD ConnectionList
Definition: fltmgrint.h:121
LIST_ENTRY mList
Definition: fltmgrint.h:56
FAST_MUTEX mLock
Definition: fltmgrint.h:55
PFLT_DISCONNECT_NOTIFY DisconnectNotify
Definition: fltmgrint.h:192
PFLT_MESSAGE_NOTIFY MessageNotify
Definition: fltmgrint.h:193
PFLT_CONNECT_NOTIFY ConnectNotify
Definition: fltmgrint.h:191
#define RtlZeroMemory(Destination, Length)
Definition: typedefs.h:262
#define STATUS_INVALID_PARAMETER
Definition: udferr_usr.h:135

◆ 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.

291{
295}
@ WdfRequestTypeNoFormat
Definition: wdfdevice.h:533
struct _WDF_REQUEST_COMPLETION_PARAMS WDF_REQUEST_COMPLETION_PARAMS

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.

456{
458
461}
struct _WDF_REQUEST_FORWARD_OPTIONS WDF_REQUEST_FORWARD_OPTIONS

◆ WDF_REQUEST_PARAMETERS_INIT()

FORCEINLINE VOID WDF_REQUEST_PARAMETERS_INIT ( _Out_ PWDF_REQUEST_PARAMETERS  Parameters)

Definition at line 211 of file wdfrequest.h.

214{
216
217 Parameters->Size = sizeof(WDF_REQUEST_PARAMETERS);
218}
_Must_inspect_result_ _In_ WDFQUEUE _In_opt_ WDFREQUEST _In_opt_ WDFFILEOBJECT _Inout_opt_ PWDF_REQUEST_PARAMETERS Parameters
Definition: wdfio.h:869
struct _WDF_REQUEST_PARAMETERS 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.

369{
371
372 Params->Size = sizeof(WDF_REQUEST_REUSE_PARAMS);
373 Params->Flags = Flags;
374 Params->Status = Status;
375}
struct _WDF_REQUEST_REUSE_PARAMS WDF_REQUEST_REUSE_PARAMS
_Must_inspect_result_ _In_ ULONG Flags
Definition: wsk.h:170

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.

383{
385 Params->NewIrp = NewIrp;
386}

◆ WDF_REQUEST_SEND_OPTIONS_INIT()

◆ WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT()

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

◆ 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.

685{
687}
@ WdfRequestSendTableIndex
Definition: wdffuncenum.h:278
_In_ WDFIOTARGET Target
Definition: wdfrequest.h:306
_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: wdfrequest.h:662

Referenced by RequestSend().