wdfiotarget.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_IO_TARGET_OPEN_PARAMS

Macros
#define	WDF_EXTERN_C
#define	WDF_EXTERN_C_START
#define	WDF_EXTERN_C_END

Typedefs
typedef WDF_EXTERN_C_START enum _WDF_IO_TARGET_STATE	WDF_IO_TARGET_STATE
typedef WDF_EXTERN_C_START enum _WDF_IO_TARGET_STATE *	PWDF_IO_TARGET_STATE
typedef enum _WDF_IO_TARGET_OPEN_TYPE	WDF_IO_TARGET_OPEN_TYPE
typedef enum _WDF_IO_TARGET_SENT_IO_ACTION	WDF_IO_TARGET_SENT_IO_ACTION
typedef enum _WDF_IO_TARGET_PURGE_IO_ACTION	WDF_IO_TARGET_PURGE_IO_ACTION
typedef EVT_WDF_IO_TARGET_QUERY_REMOVE *	PFN_WDF_IO_TARGET_QUERY_REMOVE
typedef EVT_WDF_IO_TARGET_REMOVE_CANCELED *	PFN_WDF_IO_TARGET_REMOVE_CANCELED
typedef EVT_WDF_IO_TARGET_REMOVE_COMPLETE *	PFN_WDF_IO_TARGET_REMOVE_COMPLETE
typedef struct _WDF_IO_TARGET_OPEN_PARAMS	WDF_IO_TARGET_OPEN_PARAMS
typedef struct _WDF_IO_TARGET_OPEN_PARAMS *	PWDF_IO_TARGET_OPEN_PARAMS
typedef _Must_inspect_result_	_IRQL_requires_max_(PASSIVE_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFIOTARGETCREATE) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_ WDFDEVICE	Device
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES	IoTargetAttributes
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFIOTARGET *	IoTarget
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ PWDF_IO_TARGET_OPEN_PARAMS	OpenParams
typedef _In_ WDFIOTARGET _In_ _Strict_type_match_ WDF_IO_TARGET_SENT_IO_ACTION	Action
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ DEVICE_REGISTRY_PROPERTY	DeviceProperty
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ DEVICE_REGISTRY_PROPERTY _In_ ULONG	BufferLength
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ DEVICE_REGISTRY_PROPERTY _In_ ULONG	_When_(BufferLength !=0, _Out_writes_bytes_to_opt_(BufferLength, *ResultLength)) _When_(BufferLength == 0
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ DEVICE_REGISTRY_PROPERTY _In_ ULONG _Out_opt_ PVOID	PropertyBuffer
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ DEVICE_REGISTRY_PROPERTY _In_ ULONG _Out_opt_ PVOID	_Deref_out_range_(<=, BufferLength) PULONG ResultLength)
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ DEVICE_REGISTRY_PROPERTY _In_ _Strict_type_match_ POOL_TYPE	PoolType
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ DEVICE_REGISTRY_PROPERTY _In_ _Strict_type_match_ POOL_TYPE _In_opt_ PWDF_OBJECT_ATTRIBUTES	PropertyMemoryAttributes
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ DEVICE_REGISTRY_PROPERTY _In_ _Strict_type_match_ POOL_TYPE _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFMEMORY *	PropertyMemory
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ LPCGUID	InterfaceType
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ LPCGUID _Out_ PINTERFACE	Interface
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ LPCGUID _Out_ PINTERFACE _In_ USHORT	Size
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ LPCGUID _Out_ PINTERFACE _In_ USHORT _In_ USHORT	Version
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ LPCGUID _Out_ PINTERFACE _In_ USHORT _In_ USHORT _In_opt_ PVOID	InterfaceSpecificData
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_opt_ WDFREQUEST	Request
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_opt_ WDFREQUEST _In_opt_ PWDF_MEMORY_DESCRIPTOR	OutputBuffer = NULL
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_opt_ WDFREQUEST _In_opt_ PWDF_MEMORY_DESCRIPTOR _In_opt_ PLONGLONG	DeviceOffset
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_opt_ WDFREQUEST _In_opt_ PWDF_MEMORY_DESCRIPTOR _In_opt_ PLONGLONG _In_opt_ PWDF_REQUEST_SEND_OPTIONS	RequestOptions
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_opt_ WDFREQUEST _In_opt_ PWDF_MEMORY_DESCRIPTOR _In_opt_ PLONGLONG _In_opt_ PWDF_REQUEST_SEND_OPTIONS _Out_opt_ PULONG_PTR	BytesRead
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ WDFREQUEST _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET	OutputBufferOffset
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_opt_ WDFREQUEST _In_opt_ PWDF_MEMORY_DESCRIPTOR	InputBuffer = NULL
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_opt_ WDFREQUEST _In_opt_ PWDF_MEMORY_DESCRIPTOR _In_opt_ PLONGLONG _In_opt_ PWDF_REQUEST_SEND_OPTIONS _Out_opt_ PULONG_PTR	BytesWritten
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ WDFREQUEST _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET	InputBufferOffset
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_opt_ WDFREQUEST _In_ ULONG	IoctlCode
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_opt_ WDFREQUEST _In_ ULONG _In_opt_ PWDF_MEMORY_DESCRIPTOR _In_opt_ PWDF_MEMORY_DESCRIPTOR _In_opt_ PWDF_REQUEST_SEND_OPTIONS _Out_opt_ PULONG_PTR	BytesReturned
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_opt_ WDFREQUEST _In_ ULONG _In_opt_ PWDF_MEMORY_DESCRIPTOR	OtherArg1
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_opt_ WDFREQUEST _In_ ULONG _In_opt_ PWDF_MEMORY_DESCRIPTOR _In_opt_ PWDF_MEMORY_DESCRIPTOR	OtherArg2
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_opt_ WDFREQUEST _In_ ULONG _In_opt_ PWDF_MEMORY_DESCRIPTOR _In_opt_ PWDF_MEMORY_DESCRIPTOR _In_opt_ PWDF_MEMORY_DESCRIPTOR	OtherArg4
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ WDFREQUEST _In_ ULONG _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET	OtherArg1Offset
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ WDFREQUEST _In_ ULONG _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET	OtherArg2Offset
typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ WDFREQUEST _In_ ULONG _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET	OtherArg4Offset

Enumerations
enum	_WDF_IO_TARGET_STATE {   WdfIoTargetStateUndefined = 0 , WdfIoTargetStarted , WdfIoTargetStopped , WdfIoTargetClosedForQueryRemove ,   WdfIoTargetClosed , WdfIoTargetDeleted , WdfIoTargetPurged }
enum	_WDF_IO_TARGET_OPEN_TYPE {   WdfIoTargetOpenUndefined = 0 , WdfIoTargetOpenUseExistingDevice = 1 , WdfIoTargetOpenByName = 2 , WdfIoTargetOpenReopen = 3 ,   WdfIoTargetOpenLocalTargetByFile = 4 }
enum	_WDF_IO_TARGET_SENT_IO_ACTION { WdfIoTargetSentIoUndefined = 0 , WdfIoTargetCancelSentIo , WdfIoTargetWaitForSentIoToComplete , WdfIoTargetLeaveSentIoPending }
enum	_WDF_IO_TARGET_PURGE_IO_ACTION { WdfIoTargetPurgeIoUndefined = 0 , WdfIoTargetPurgeIoAndWait = 1 , WdfIoTargetPurgeIo = 2 }

Functions
typedef	_Function_class_ (EVT_WDF_IO_TARGET_QUERY_REMOVE) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_IO_TARGET_QUERY_REMOVE(_In_ WDFIOTARGET IoTarget)
typedef	_Function_class_ (EVT_WDF_IO_TARGET_REMOVE_CANCELED) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) VOID STDCALL EVT_WDF_IO_TARGET_REMOVE_CANCELED(_In_ WDFIOTARGET IoTarget)
typedef	_Function_class_ (EVT_WDF_IO_TARGET_REMOVE_COMPLETE) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) VOID STDCALL EVT_WDF_IO_TARGET_REMOVE_COMPLETE(_In_ WDFIOTARGET IoTarget)
FORCEINLINE VOID	WDF_IO_TARGET_OPEN_PARAMS_INIT_EXISTING_DEVICE (_Out_ PWDF_IO_TARGET_OPEN_PARAMS Params, _In_ PDEVICE_OBJECT DeviceObject)
FORCEINLINE VOID	WDF_IO_TARGET_OPEN_PARAMS_INIT_CREATE_BY_NAME (_Out_ PWDF_IO_TARGET_OPEN_PARAMS Params, _In_ PCUNICODE_STRING TargetDeviceName, _In_ ACCESS_MASK DesiredAccess)
FORCEINLINE VOID	WDF_IO_TARGET_OPEN_PARAMS_INIT_OPEN_BY_NAME (_Out_ PWDF_IO_TARGET_OPEN_PARAMS Params, _In_ PCUNICODE_STRING TargetDeviceName, _In_ ACCESS_MASK DesiredAccess)
FORCEINLINE VOID	WDF_IO_TARGET_OPEN_PARAMS_INIT_REOPEN (_Out_ PWDF_IO_TARGET_OPEN_PARAMS Params)
_Must_inspect_result_	_IRQL_requires_max_ (DISPATCH_LEVEL) FORCEINLINE NTSTATUS WdfIoTargetStart(_In_ WDFIOTARGET IoTarget)
typedef	_When_ (Action==3, _IRQL_requires_max_(DISPATCH_LEVEL)) _When_(Action

Macro Definition Documentation

WDF_EXTERN_C

#define WDF_EXTERN_C

Definition at line 38 of file wdfiotarget.h.

WDF_EXTERN_C_END

#define WDF_EXTERN_C_END

Definition at line 40 of file wdfiotarget.h.

WDF_EXTERN_C_START

#define WDF_EXTERN_C_START

Definition at line 39 of file wdfiotarget.h.

Typedef Documentation

_Deref_out_range_

_Must_inspect_result_ _In_ DEVICE_REGISTRY_PROPERTY _In_ ULONG _Out_opt_ PVOID _Deref_out_range_

Definition at line 630 of file wdfiotarget.h.

_IRQL_requires_max_

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

Definition at line 356 of file wdfiotarget.h.

_When_

typedef _Must_inspect_result_ _In_ WDFIOTARGET _In_ DEVICE_REGISTRY_PROPERTY _In_ ULONG _When_(BufferLength !=0, _Out_writes_bytes_to_opt_(BufferLength, *ResultLength)) _When_(BufferLength == 0

Definition at line 627 of file wdfiotarget.h.

Action

_In_ WDFIOTARGET _In_ _Strict_type_match_ WDF_IO_TARGET_PURGE_IO_ACTION Action

Initial value:

{
    ((PFN_WDFIOTARGETSTOP) WdfFunctions[WdfIoTargetStopTableIndex])(WdfDriverGlobals, IoTarget, Action)

Definition at line 509 of file wdfiotarget.h.

BufferLength

_Must_inspect_result_ _In_ DEVICE_REGISTRY_PROPERTY _In_ ULONG BufferLength

Definition at line 626 of file wdfiotarget.h.

BytesRead

_Must_inspect_result_ _In_ WDFUSBPIPE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _In_opt_ PWDF_MEMORY_DESCRIPTOR _Out_opt_ PULONG BytesRead

Initial value:

{
    return ((PFN_WDFIOTARGETSENDREADSYNCHRONOUSLY) WdfFunctions[WdfIoTargetSendReadSynchronouslyTableIndex])(WdfDriverGlobals, IoTarget, Request, OutputBuffer, DeviceOffset, RequestOptions, BytesRead)

Definition at line 869 of file wdfiotarget.h.

BytesReturned

_Must_inspect_result_ __in WDFIOTARGET __in_opt WDFREQUEST __in ULONG __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PWDF_MEMORY_DESCRIPTOR __in_opt PWDF_REQUEST_SEND_OPTIONS __out_opt PULONG_PTR BytesReturned

Initial value:

{
    return ((PFN_WDFIOTARGETSENDIOCTLSYNCHRONOUSLY) WdfFunctions[WdfIoTargetSendIoctlSynchronouslyTableIndex])(WdfDriverGlobals, IoTarget, Request, IoctlCode, InputBuffer, OutputBuffer, RequestOptions, BytesReturned)

Definition at line 1051 of file wdfiotarget.h.

BytesWritten

_Must_inspect_result_ _In_ WDFUSBPIPE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS _In_opt_ PWDF_MEMORY_DESCRIPTOR _Out_opt_ PULONG BytesWritten

Initial value:

{
    return ((PFN_WDFIOTARGETSENDWRITESYNCHRONOUSLY) WdfFunctions[WdfIoTargetSendWriteSynchronouslyTableIndex])(WdfDriverGlobals, IoTarget, Request, InputBuffer, DeviceOffset, RequestOptions, BytesWritten)

Definition at line 959 of file wdfiotarget.h.

Device

typedef _Must_inspect_result_ _In_ WDFDEVICE Device

Definition at line 363 of file wdfiotarget.h.

DeviceOffset

_Must_inspect_result_ _In_ WDFIOTARGET _In_ WDFREQUEST _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET _In_opt_ PLONGLONG DeviceOffset

Initial value:

{
    return ((PFN_WDFIOTARGETFORMATREQUESTFORREAD) WdfFunctions[WdfIoTargetFormatRequestForReadTableIndex])(WdfDriverGlobals, IoTarget, Request, OutputBuffer, OutputBufferOffset, DeviceOffset)

Definition at line 865 of file wdfiotarget.h.

DeviceProperty

_Must_inspect_result_ _In_ DEVICE_REGISTRY_PROPERTY DeviceProperty

Definition at line 624 of file wdfiotarget.h.

InputBuffer

_Must_inspect_result_ _In_ WDFIOTARGET _In_ WDFREQUEST _In_ ULONG _In_opt_ WDFMEMORY InputBuffer = NULL

Definition at line 953 of file wdfiotarget.h.

InputBufferOffset

_Must_inspect_result_ _In_ WDFIOTARGET _In_ WDFREQUEST _In_ ULONG _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET InputBufferOffset

Definition at line 1002 of file wdfiotarget.h.

Interface

_Must_inspect_result_ _In_ LPCGUID _Out_ PINTERFACE Interface

Definition at line 716 of file wdfiotarget.h.

InterfaceSpecificData

_Must_inspect_result_ _In_ LPCGUID _Out_ PINTERFACE _In_ USHORT _In_ USHORT _In_opt_ PVOID InterfaceSpecificData

Initial value:

{
    return ((PFN_WDFIOTARGETQUERYFORINTERFACE) WdfFunctions[WdfIoTargetQueryForInterfaceTableIndex])(WdfDriverGlobals, IoTarget, InterfaceType, Interface, Size, Version, InterfaceSpecificData)

Definition at line 722 of file wdfiotarget.h.

InterfaceType

_Must_inspect_result_ _In_ LPCGUID InterfaceType

Definition at line 714 of file wdfiotarget.h.

IoctlCode

_Must_inspect_result_ _In_ WDFIOTARGET _In_ WDFREQUEST _In_ ULONG IoctlCode

Definition at line 1043 of file wdfiotarget.h.

IoTarget

_Must_inspect_result_ _In_ WDFREQUEST _In_ WDFIOTARGET IoTarget

Initial value:

{
    return ((PFN_WDFIOTARGETCREATE) WdfFunctions[WdfIoTargetCreateTableIndex])(WdfDriverGlobals, Device, IoTargetAttributes, IoTarget)

Definition at line 367 of file wdfiotarget.h.

IoTargetAttributes

_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES IoTargetAttributes

Definition at line 365 of file wdfiotarget.h.

OpenParams

_Must_inspect_result_ _In_ PWDF_IO_TARGET_OPEN_PARAMS OpenParams

Initial value:

{
    return ((PFN_WDFIOTARGETOPEN) WdfFunctions[WdfIoTargetOpenTableIndex])(WdfDriverGlobals, IoTarget, OpenParams)

Definition at line 400 of file wdfiotarget.h.

OtherArg1

_Must_inspect_result_ __in WDFIOTARGET __in WDFREQUEST __in ULONG __in_opt WDFMEMORY OtherArg1

Definition at line 1249 of file wdfiotarget.h.

OtherArg1Offset

_Must_inspect_result_ _In_ WDFREQUEST _In_ ULONG _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET OtherArg1Offset

Definition at line 1306 of file wdfiotarget.h.

OtherArg2

_Must_inspect_result_ __in WDFIOTARGET __in WDFREQUEST __in ULONG __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET __in_opt WDFMEMORY OtherArg2

Definition at line 1251 of file wdfiotarget.h.

OtherArg2Offset

_Must_inspect_result_ _In_ WDFREQUEST _In_ ULONG _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET OtherArg2Offset

Definition at line 1310 of file wdfiotarget.h.

OtherArg4

_Must_inspect_result_ __in WDFIOTARGET __in WDFREQUEST __in ULONG __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET __in_opt WDFMEMORY __in_opt PWDFMEMORY_OFFSET __in_opt WDFMEMORY OtherArg4

Definition at line 1253 of file wdfiotarget.h.

OtherArg4Offset

_Must_inspect_result_ _In_ WDFREQUEST _In_ ULONG _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET OtherArg4Offset

Initial value:

{
    return ((PFN_WDFIOTARGETFORMATREQUESTFORINTERNALIOCTLOTHERS) WdfFunctions[WdfIoTargetFormatRequestForInternalIoctlOthersTableIndex])(WdfDriverGlobals, IoTarget, Request, IoctlCode, OtherArg1, OtherArg1Offset, OtherArg2, OtherArg2Offset, OtherArg4, OtherArg4Offset)

Definition at line 1314 of file wdfiotarget.h.

OutputBuffer

_Must_inspect_result_ _In_ WDFIOTARGET _In_ WDFREQUEST _In_ ULONG _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET _In_opt_ WDFMEMORY OutputBuffer = NULL

Definition at line 863 of file wdfiotarget.h.

OutputBufferOffset

_Must_inspect_result_ _In_ WDFIOTARGET _In_ WDFREQUEST _In_ ULONG _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET _In_opt_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET OutputBufferOffset

Initial value:

{
    return ((PFN_WDFIOTARGETFORMATREQUESTFORIOCTL) WdfFunctions[WdfIoTargetFormatRequestForIoctlTableIndex])(WdfDriverGlobals, IoTarget, Request, IoctlCode, InputBuffer, InputBufferOffset, OutputBuffer, OutputBufferOffset)

Definition at line 912 of file wdfiotarget.h.

PFN_WDF_IO_TARGET_QUERY_REMOVE

typedef EVT_WDF_IO_TARGET_QUERY_REMOVE* PFN_WDF_IO_TARGET_QUERY_REMOVE

Definition at line 95 of file wdfiotarget.h.

PFN_WDF_IO_TARGET_REMOVE_CANCELED

typedef EVT_WDF_IO_TARGET_REMOVE_CANCELED* PFN_WDF_IO_TARGET_REMOVE_CANCELED

Definition at line 108 of file wdfiotarget.h.

PFN_WDF_IO_TARGET_REMOVE_COMPLETE

typedef EVT_WDF_IO_TARGET_REMOVE_COMPLETE* PFN_WDF_IO_TARGET_REMOVE_COMPLETE

Definition at line 121 of file wdfiotarget.h.

PoolType

_Must_inspect_result_ _In_ DEVICE_REGISTRY_PROPERTY _In_ _Strict_type_match_ POOL_TYPE PoolType

Definition at line 672 of file wdfiotarget.h.

PropertyBuffer

_Must_inspect_result_ _In_ DEVICE_REGISTRY_PROPERTY _In_ ULONG _Out_opt_ PVOID PropertyBuffer

Definition at line 629 of file wdfiotarget.h.

PropertyMemory

_Must_inspect_result_ _In_ DEVICE_REGISTRY_PROPERTY _In_ _Strict_type_match_ POOL_TYPE _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFMEMORY* PropertyMemory

Initial value:

{
    return ((PFN_WDFIOTARGETALLOCANDQUERYTARGETPROPERTY) WdfFunctions[WdfIoTargetAllocAndQueryTargetPropertyTableIndex])(WdfDriverGlobals, IoTarget, DeviceProperty, PoolType, PropertyMemoryAttributes, PropertyMemory)

Definition at line 676 of file wdfiotarget.h.

PropertyMemoryAttributes

_Must_inspect_result_ _In_ DEVICE_REGISTRY_PROPERTY _In_ _Strict_type_match_ POOL_TYPE _In_opt_ PWDF_OBJECT_ATTRIBUTES PropertyMemoryAttributes

Definition at line 674 of file wdfiotarget.h.

PWDF_IO_TARGET_OPEN_PARAMS

typedef struct _WDF_IO_TARGET_OPEN_PARAMS * PWDF_IO_TARGET_OPEN_PARAMS

PWDF_IO_TARGET_STATE

typedef WDF_EXTERN_C_START enum _WDF_IO_TARGET_STATE * PWDF_IO_TARGET_STATE

Request

_Must_inspect_result_ _In_ WDFREQUEST Request

Definition at line 861 of file wdfiotarget.h.

RequestOptions

_Must_inspect_result_ _In_ WDFUSBPIPE _In_opt_ WDFREQUEST _In_opt_ PWDF_REQUEST_SEND_OPTIONS RequestOptions

Initial value:

{
    return ((PFN_WDFUSBTARGETPIPEABORTSYNCHRONOUSLY) WdfFunctions[WdfUsbTargetPipeAbortSynchronouslyTableIndex])(WdfDriverGlobals, Pipe, Request, RequestOptions)

Definition at line 867 of file wdfiotarget.h.

Size

_Must_inspect_result_ _In_ LPCGUID _Out_ PINTERFACE _In_ USHORT Size

Definition at line 718 of file wdfiotarget.h.

Version

_Must_inspect_result_ _In_ LPCGUID _Out_ PINTERFACE _In_ USHORT _In_ USHORT Version

Definition at line 720 of file wdfiotarget.h.

WDF_IO_TARGET_OPEN_PARAMS

typedef struct _WDF_IO_TARGET_OPEN_PARAMS WDF_IO_TARGET_OPEN_PARAMS

WDF_IO_TARGET_OPEN_TYPE

typedef enum _WDF_IO_TARGET_OPEN_TYPE WDF_IO_TARGET_OPEN_TYPE

WDF_IO_TARGET_PURGE_IO_ACTION

typedef enum _WDF_IO_TARGET_PURGE_IO_ACTION WDF_IO_TARGET_PURGE_IO_ACTION

WDF_IO_TARGET_SENT_IO_ACTION

typedef enum _WDF_IO_TARGET_SENT_IO_ACTION WDF_IO_TARGET_SENT_IO_ACTION

WDF_IO_TARGET_STATE

typedef WDF_EXTERN_C_START enum _WDF_IO_TARGET_STATE WDF_IO_TARGET_STATE

Enumeration Type Documentation

_WDF_IO_TARGET_OPEN_TYPE

enum _WDF_IO_TARGET_OPEN_TYPE

Enumerator
WdfIoTargetOpenUndefined
WdfIoTargetOpenUseExistingDevice
WdfIoTargetOpenByName
WdfIoTargetOpenReopen
WdfIoTargetOpenLocalTargetByFile

Definition at line 61 of file wdfiotarget.h.

                                      {
    WdfIoTargetOpenUndefined = 0,
    WdfIoTargetOpenUseExistingDevice = 1,
    WdfIoTargetOpenByName = 2,
    WdfIoTargetOpenReopen = 3,
    WdfIoTargetOpenLocalTargetByFile = 4,
} WDF_IO_TARGET_OPEN_TYPE;

_WDF_IO_TARGET_PURGE_IO_ACTION

enum _WDF_IO_TARGET_PURGE_IO_ACTION

Enumerator
WdfIoTargetPurgeIoUndefined
WdfIoTargetPurgeIoAndWait
WdfIoTargetPurgeIo

Definition at line 76 of file wdfiotarget.h.

                                            {
    WdfIoTargetPurgeIoUndefined = 0,
    WdfIoTargetPurgeIoAndWait = 1,
    WdfIoTargetPurgeIo = 2,
} WDF_IO_TARGET_PURGE_IO_ACTION;

_WDF_IO_TARGET_SENT_IO_ACTION

enum _WDF_IO_TARGET_SENT_IO_ACTION

Enumerator
WdfIoTargetSentIoUndefined
WdfIoTargetCancelSentIo
WdfIoTargetWaitForSentIoToComplete
WdfIoTargetLeaveSentIoPending

Definition at line 69 of file wdfiotarget.h.

                                           {
    WdfIoTargetSentIoUndefined = 0,
    WdfIoTargetCancelSentIo,
    WdfIoTargetWaitForSentIoToComplete,
    WdfIoTargetLeaveSentIoPending,
} WDF_IO_TARGET_SENT_IO_ACTION;

_WDF_IO_TARGET_STATE

enum _WDF_IO_TARGET_STATE

Enumerator
WdfIoTargetStateUndefined
WdfIoTargetStarted
WdfIoTargetStopped
WdfIoTargetClosedForQueryRemove
WdfIoTargetClosed
WdfIoTargetDeleted
WdfIoTargetPurged

Definition at line 51 of file wdfiotarget.h.

                                  {
    WdfIoTargetStateUndefined = 0,
    WdfIoTargetStarted,
    WdfIoTargetStopped,
    WdfIoTargetClosedForQueryRemove,
    WdfIoTargetClosed,
    WdfIoTargetDeleted,
    WdfIoTargetPurged,
} WDF_IO_TARGET_STATE, *PWDF_IO_TARGET_STATE;

Function Documentation

_Function_class_() [1/3]

typedef _Function_class_

(

EVT_WDF_IO_TARGET_QUERY_REMOVE

)

_Function_class_() [2/3]

typedef _Function_class_

(

EVT_WDF_IO_TARGET_REMOVE_CANCELED

)

_Function_class_() [3/3]

typedef _Function_class_

(

EVT_WDF_IO_TARGET_REMOVE_COMPLETE

)

_IRQL_requires_max_()

_Must_inspect_result_ _IRQL_requires_max_

(

DISPATCH_LEVEL

)

Definition at line 483 of file wdfiotarget.h.

{
    return ((PFN_WDFIOTARGETSTART) WdfFunctions[WdfIoTargetStartTableIndex])(WdfDriverGlobals, IoTarget);
}

_When_()

typedef _When_	(	Action	= = 3,
		_IRQL_requires_max_(DISPATCH_LEVEL)
	)

WDF_IO_TARGET_OPEN_PARAMS_INIT_CREATE_BY_NAME()

FORCEINLINE VOID WDF_IO_TARGET_OPEN_PARAMS_INIT_CREATE_BY_NAME	(	_Out_ PWDF_IO_TARGET_OPEN_PARAMS	Params,
		_In_ PCUNICODE_STRING	TargetDeviceName,
		_In_ ACCESS_MASK	DesiredAccess
	)

Definition at line 303 of file wdfiotarget.h.

{
    RtlZeroMemory(Params, sizeof(WDF_IO_TARGET_OPEN_PARAMS));
 
    Params->Size = sizeof(WDF_IO_TARGET_OPEN_PARAMS);
    Params->Type = WdfIoTargetOpenByName;
 
    RtlCopyMemory(&Params->TargetDeviceName,
                  TargetDeviceName,
                  sizeof(UNICODE_STRING));
    Params->DesiredAccess = DesiredAccess;
    Params->CreateOptions = FILE_NON_DIRECTORY_FILE;
}

Referenced by WDF_IO_TARGET_OPEN_PARAMS_INIT_OPEN_BY_NAME().

WDF_IO_TARGET_OPEN_PARAMS_INIT_EXISTING_DEVICE()

FORCEINLINE VOID WDF_IO_TARGET_OPEN_PARAMS_INIT_EXISTING_DEVICE	(	_Out_ PWDF_IO_TARGET_OPEN_PARAMS	Params,
		_In_ PDEVICE_OBJECT	DeviceObject
	)

Definition at line 287 of file wdfiotarget.h.

{
    RtlZeroMemory(Params, sizeof(WDF_IO_TARGET_OPEN_PARAMS));
 
    Params->Size = sizeof(WDF_IO_TARGET_OPEN_PARAMS);
    Params->Type = WdfIoTargetOpenUseExistingDevice;
 
    Params->TargetDeviceObject = DeviceObject;
}

Referenced by DriverEvtDeviceAdd().

WDF_IO_TARGET_OPEN_PARAMS_INIT_OPEN_BY_NAME()

FORCEINLINE VOID WDF_IO_TARGET_OPEN_PARAMS_INIT_OPEN_BY_NAME	(	_Out_ PWDF_IO_TARGET_OPEN_PARAMS	Params,
		_In_ PCUNICODE_STRING	TargetDeviceName,
		_In_ ACCESS_MASK	DesiredAccess
	)

Definition at line 323 of file wdfiotarget.h.

{
    WDF_IO_TARGET_OPEN_PARAMS_INIT_CREATE_BY_NAME(Params,
                                                  TargetDeviceName,
                                                  DesiredAccess);
    Params->CreateDisposition = FILE_OPEN;
}

WDF_IO_TARGET_OPEN_PARAMS_INIT_REOPEN()

FORCEINLINE VOID WDF_IO_TARGET_OPEN_PARAMS_INIT_REOPEN

(

_Out_ PWDF_IO_TARGET_OPEN_PARAMS

Params

)

Definition at line 340 of file wdfiotarget.h.

{
    RtlZeroMemory(Params, sizeof(WDF_IO_TARGET_OPEN_PARAMS));
 
    Params->Size = sizeof(WDF_IO_TARGET_OPEN_PARAMS);
    Params->Type = WdfIoTargetOpenReopen;
}

Referenced by FxIoTargetRemoteNotificationCallback::OnRemoveCanceled().