wdfchildlist.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_CHILD_IDENTIFICATION_DESCRIPTION_HEADER
struct	_WDF_CHILD_ADDRESS_DESCRIPTION_HEADER
struct	_WDF_CHILD_RETRIEVE_INFO
struct	_WDF_CHILD_LIST_CONFIG
struct	_WDF_CHILD_LIST_ITERATOR

Macros
#define	WDF_EXTERN_C
#define	WDF_EXTERN_C_START
#define	WDF_EXTERN_C_END

Typedefs
typedef WDF_EXTERN_C_START enum _WDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS	WDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS
typedef WDF_EXTERN_C_START enum _WDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS *	PWDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS
typedef enum _WDF_RETRIEVE_CHILD_FLAGS	WDF_RETRIEVE_CHILD_FLAGS
typedef struct _WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER	WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER
typedef struct _WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER *	PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER
typedef struct _WDF_CHILD_ADDRESS_DESCRIPTION_HEADER	WDF_CHILD_ADDRESS_DESCRIPTION_HEADER
typedef struct _WDF_CHILD_ADDRESS_DESCRIPTION_HEADER *	PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER
typedef _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER	IdentificationDescription
typedef _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER _In_ PWDFDEVICE_INIT	ChildInit
typedef EVT_WDF_CHILD_LIST_CREATE_DEVICE *	PFN_WDF_CHILD_LIST_CREATE_DEVICE
typedef EVT_WDF_CHILD_LIST_SCAN_FOR_CHILDREN *	PFN_WDF_CHILD_LIST_SCAN_FOR_CHILDREN
typedef _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER	SourceIdentificationDescription
typedef _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER _Out_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER	DestinationIdentificationDescription
typedef EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COPY *	PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COPY
typedef EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_DUPLICATE *	PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_DUPLICATE
typedef _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER	FirstIdentificationDescription
typedef _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER	SecondIdentificationDescription
typedef EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COMPARE *	PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COMPARE
typedef EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_CLEANUP *	PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_CLEANUP
typedef _In_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER	SourceAddressDescription
typedef _In_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER _Out_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER	DestinationAddressDescription
typedef EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_COPY *	PFN_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_COPY
typedef EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_DUPLICATE *	PFN_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_DUPLICATE
typedef _Inout_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER	AddressDescription
typedef EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_CLEANUP *	PFN_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_CLEANUP
typedef _In_ WDFDEVICE	OldDevice
typedef _In_ WDFDEVICE _In_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER	OldAddressDescription
typedef _In_ WDFDEVICE _In_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER _Out_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER	NewAddressDescription
typedef EVT_WDF_CHILD_LIST_DEVICE_REENUMERATED *	PFN_WDF_CHILD_LIST_DEVICE_REENUMERATED
typedef struct _WDF_CHILD_RETRIEVE_INFO	WDF_CHILD_RETRIEVE_INFO
typedef struct _WDF_CHILD_RETRIEVE_INFO *	PWDF_CHILD_RETRIEVE_INFO
typedef struct _WDF_CHILD_LIST_CONFIG	WDF_CHILD_LIST_CONFIG
typedef struct _WDF_CHILD_LIST_CONFIG *	PWDF_CHILD_LIST_CONFIG
typedef struct _WDF_CHILD_LIST_ITERATOR	WDF_CHILD_LIST_ITERATOR
typedef struct _WDF_CHILD_LIST_ITERATOR *	PWDF_CHILD_LIST_ITERATOR
typedef _Must_inspect_result_	_IRQL_requires_max_(PASSIVE_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFCHILDLISTCREATE) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals == 0
	Modifies some information data about a security descriptor. More...
typedef _Must_inspect_result_ _In_ WDFDEVICE	Device
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_CHILD_LIST_CONFIG	Config
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_CHILD_LIST_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES	ChildListAttributes
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_CHILD_LIST_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFCHILDLIST *	ChildList
typedef _Must_inspect_result_ _In_ WDFCHILDLIST _Inout_ PWDF_CHILD_RETRIEVE_INFO	RetrieveInfo
typedef _In_ WDFCHILDLIST _In_ PWDF_CHILD_LIST_ITERATOR	Iterator
typedef _Must_inspect_result_ _In_ WDFCHILDLIST _In_ PWDF_CHILD_LIST_ITERATOR _Out_ WDFDEVICE _Inout_opt_ PWDF_CHILD_RETRIEVE_INFO	Info

Enumerations
enum	_WDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS { WdfChildListRetrieveDeviceUndefined = 0, WdfChildListRetrieveDeviceSuccess, WdfChildListRetrieveDeviceNotYetCreated, WdfChildListRetrieveDeviceNoSuchDevice }
enum	_WDF_RETRIEVE_CHILD_FLAGS {   WdfRetrieveUnspecified = 0x0000, WdfRetrievePresentChildren = 0x0001, WdfRetrieveMissingChildren = 0x0002, WdfRetrievePendingChildren = 0x0004,   WdfRetrieveAddedChildren = (WdfRetrievePresentChildren | WdfRetrievePendingChildren), WdfRetrieveAllChildren = (WdfRetrievePresentChildren | WdfRetrievePendingChildren | WdfRetrieveMissingChildren) }

Functions
FORCEINLINE VOID	WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT (_Out_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER Header, _In_ ULONG IdentificationDescriptionSize)
FORCEINLINE VOID	WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT (_Out_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER Header, _In_ ULONG AddressDescriptionSize)
typedef	_Function_class_ (EVT_WDF_CHILD_LIST_CREATE_DEVICE) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_CHILD_LIST_CREATE_DEVICE(_In_ WDFCHILDLIST ChildList
typedef	_Function_class_ (EVT_WDF_CHILD_LIST_SCAN_FOR_CHILDREN) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) VOID STDCALL EVT_WDF_CHILD_LIST_SCAN_FOR_CHILDREN(_In_ WDFCHILDLIST ChildList)
typedef	_Function_class_ (EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COPY) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COPY(_In_ WDFCHILDLIST ChildList
typedef	_Function_class_ (EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_DUPLICATE) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) NTSTATUS STDCALL EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_DUPLICATE(_In_ WDFCHILDLIST ChildList
typedef	_Function_class_ (EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COMPARE) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) BOOLEAN STDCALL EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COMPARE(_In_ WDFCHILDLIST ChildList
typedef	_Function_class_ (EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_CLEANUP) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_CLEANUP(_In_ WDFCHILDLIST ChildList
typedef	_Function_class_ (EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_COPY) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_COPY(_In_ WDFCHILDLIST ChildList
typedef	_Function_class_ (EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_DUPLICATE) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) NTSTATUS STDCALL EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_DUPLICATE(_In_ WDFCHILDLIST ChildList
typedef	_Function_class_ (EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_CLEANUP) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_CLEANUP(_In_ WDFCHILDLIST ChildList
typedef	_Function_class_ (EVT_WDF_CHILD_LIST_DEVICE_REENUMERATED) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) BOOLEAN STDCALL EVT_WDF_CHILD_LIST_DEVICE_REENUMERATED(_In_ WDFCHILDLIST ChildList
FORCEINLINE VOID	WDF_CHILD_RETRIEVE_INFO_INIT (_Out_ PWDF_CHILD_RETRIEVE_INFO Info, _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription)
FORCEINLINE VOID	WDF_CHILD_LIST_CONFIG_INIT (_Out_ PWDF_CHILD_LIST_CONFIG Config, _In_ ULONG IdentificationDescriptionSize, _In_ PFN_WDF_CHILD_LIST_CREATE_DEVICE EvtChildListCreateDevice)
FORCEINLINE VOID	WDF_CHILD_LIST_ITERATOR_INIT (_Out_ PWDF_CHILD_LIST_ITERATOR Iterator, _In_ ULONG Flags)
_Must_inspect_result_	_IRQL_requires_max_ (PASSIVE_LEVEL) FORCEINLINE NTSTATUS WdfChildListCreate(_In_ WDFDEVICE Device
	Queries information details about a security descriptor. More...
typedef	_IRQL_requires_max_ (DISPATCH_LEVEL) WDFAPI WDFDEVICE(STDCALL *PFN_WDFCHILDLISTGETDEVICE)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals

Macro Definition Documentation

WDF_EXTERN_C

#define WDF_EXTERN_C

Definition at line 40 of file wdfchildlist.h.

WDF_EXTERN_C_END

#define WDF_EXTERN_C_END

Definition at line 42 of file wdfchildlist.h.

WDF_EXTERN_C_START

#define WDF_EXTERN_C_START

Definition at line 41 of file wdfchildlist.h.

Typedef Documentation

_IRQL_requires_max_

_IRQL_requires_max_ == 0

Modifies some information data 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.

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 467 of file wdfchildlist.h.

AddressDescription

_Must_inspect_result_ _In_ WDFDEVICE _Inout_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER AddressDescription

Initial value:

{
    return ((PFN_WDFCHILDLISTRETRIEVEADDRESSDESCRIPTION) WdfFunctions[WdfChildListRetrieveAddressDescriptionTableIndex])(WdfDriverGlobals, ChildList, IdentificationDescription, AddressDescription)

Definition at line 255 of file wdfchildlist.h.

ChildInit

typedef _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER _In_ PWDFDEVICE_INIT ChildInit

Definition at line 124 of file wdfchildlist.h.

ChildList

_In_ WDFCHILDLIST ChildList

Initial value:

{
    return ((PFN_WDFCHILDLISTCREATE) WdfFunctions[WdfChildListCreateTableIndex])(WdfDriverGlobals, Device, Config, ChildListAttributes, ChildList)

Definition at line 474 of file wdfchildlist.h.

ChildListAttributes

_Must_inspect_result_ _In_ PWDF_CHILD_LIST_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES ChildListAttributes

Definition at line 474 of file wdfchildlist.h.

Config

_Must_inspect_result_ _In_ PWDF_WORKITEM_CONFIG Config

Initial value:

{
    return ((PFN_WDFUSBTARGETPIPECONFIGCONTINUOUSREADER) WdfFunctions[WdfUsbTargetPipeConfigContinuousReaderTableIndex])(WdfDriverGlobals, Pipe, Config)

Definition at line 474 of file wdfchildlist.h.

DestinationAddressDescription

typedef _In_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER _Out_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER DestinationAddressDescription

Definition at line 220 of file wdfchildlist.h.

DestinationIdentificationDescription

typedef _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER _Out_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER DestinationIdentificationDescription

Definition at line 154 of file wdfchildlist.h.

Device

_Must_inspect_result_ _In_ WDFDEVICE Device

Initial value:

{
    return ((PFN_WDFDEVICECREATE) WdfFunctions[WdfDeviceCreateTableIndex])(WdfDriverGlobals, DeviceInit, DeviceAttributes, Device)

Definition at line 474 of file wdfchildlist.h.

FirstIdentificationDescription

typedef _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER FirstIdentificationDescription

Definition at line 188 of file wdfchildlist.h.

IdentificationDescription

_Must_inspect_result_ _In_ WDFDEVICE _Inout_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription

Initial value:

{
    return ((PFN_WDFCHILDLISTUPDATECHILDDESCRIPTIONASMISSING) WdfFunctions[WdfChildListUpdateChildDescriptionAsMissingTableIndex])(WdfDriverGlobals, ChildList, IdentificationDescription)

Definition at line 124 of file wdfchildlist.h.

Info

* Info

Initial value:

{
    return ((PFN_WDFCHILDLISTRETRIEVENEXTDEVICE) WdfFunctions[WdfChildListRetrieveNextDeviceTableIndex])(WdfDriverGlobals, ChildList, Iterator, Device, Info)

Definition at line 683 of file wdfchildlist.h.

Iterator

_In_ WDFCHILDLIST _In_ PWDF_CHILD_LIST_ITERATOR Iterator

Initial value:

{
    ((PFN_WDFCHILDLISTBEGINITERATION) WdfFunctions[WdfChildListBeginIterationTableIndex])(WdfDriverGlobals, ChildList, Iterator)

Definition at line 653 of file wdfchildlist.h.

NewAddressDescription

typedef _In_ WDFDEVICE _In_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER _Out_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER NewAddressDescription

Definition at line 269 of file wdfchildlist.h.

OldAddressDescription

typedef _In_ WDFDEVICE _In_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER OldAddressDescription

Definition at line 269 of file wdfchildlist.h.

OldDevice

typedef _In_ WDFDEVICE OldDevice

Definition at line 269 of file wdfchildlist.h.

PFN_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_CLEANUP

typedef EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_CLEANUP* PFN_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_CLEANUP

Definition at line 257 of file wdfchildlist.h.

PFN_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_COPY

typedef EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_COPY* PFN_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_COPY

Definition at line 225 of file wdfchildlist.h.

PFN_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_DUPLICATE

typedef EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_DUPLICATE* PFN_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_DUPLICATE

Definition at line 242 of file wdfchildlist.h.

PFN_WDF_CHILD_LIST_CREATE_DEVICE

typedef EVT_WDF_CHILD_LIST_CREATE_DEVICE* PFN_WDF_CHILD_LIST_CREATE_DEVICE

Definition at line 129 of file wdfchildlist.h.

PFN_WDF_CHILD_LIST_DEVICE_REENUMERATED

typedef EVT_WDF_CHILD_LIST_DEVICE_REENUMERATED* PFN_WDF_CHILD_LIST_DEVICE_REENUMERATED

Definition at line 276 of file wdfchildlist.h.

PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_CLEANUP

typedef EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_CLEANUP* PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_CLEANUP

Definition at line 208 of file wdfchildlist.h.

PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COMPARE

typedef EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COMPARE* PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COMPARE

Definition at line 193 of file wdfchildlist.h.

PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COPY

typedef EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COPY* PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COPY

Definition at line 159 of file wdfchildlist.h.

PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_DUPLICATE

typedef EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_DUPLICATE* PFN_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_DUPLICATE

Definition at line 176 of file wdfchildlist.h.

PFN_WDF_CHILD_LIST_SCAN_FOR_CHILDREN

typedef EVT_WDF_CHILD_LIST_SCAN_FOR_CHILDREN* PFN_WDF_CHILD_LIST_SCAN_FOR_CHILDREN

Definition at line 142 of file wdfchildlist.h.

PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER

typedef struct _WDF_CHILD_ADDRESS_DESCRIPTION_HEADER * PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER

PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER

typedef struct _WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER * PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER

PWDF_CHILD_LIST_CONFIG

typedef struct _WDF_CHILD_LIST_CONFIG * PWDF_CHILD_LIST_CONFIG

PWDF_CHILD_LIST_ITERATOR

typedef struct _WDF_CHILD_LIST_ITERATOR * PWDF_CHILD_LIST_ITERATOR

PWDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS

typedef WDF_EXTERN_C_START enum _WDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS * PWDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS

PWDF_CHILD_RETRIEVE_INFO

typedef struct _WDF_CHILD_RETRIEVE_INFO * PWDF_CHILD_RETRIEVE_INFO

RetrieveInfo

_Must_inspect_result_ _Inout_ PWDF_CHILD_RETRIEVE_INFO RetrieveInfo

Initial value:

{
    return ((PFN_WDFCHILDLISTRETRIEVEPDO) WdfFunctions[WdfChildListRetrievePdoTableIndex])(WdfDriverGlobals, ChildList, RetrieveInfo)

Definition at line 538 of file wdfchildlist.h.

SecondIdentificationDescription

typedef _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER SecondIdentificationDescription

Definition at line 188 of file wdfchildlist.h.

SourceAddressDescription

typedef _In_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER SourceAddressDescription

Definition at line 220 of file wdfchildlist.h.

SourceIdentificationDescription

typedef _In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER SourceIdentificationDescription

Definition at line 154 of file wdfchildlist.h.

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER

typedef struct _WDF_CHILD_ADDRESS_DESCRIPTION_HEADER WDF_CHILD_ADDRESS_DESCRIPTION_HEADER

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER

typedef struct _WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER

WDF_CHILD_LIST_CONFIG

typedef struct _WDF_CHILD_LIST_CONFIG WDF_CHILD_LIST_CONFIG

WDF_CHILD_LIST_ITERATOR

typedef struct _WDF_CHILD_LIST_ITERATOR WDF_CHILD_LIST_ITERATOR

WDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS

typedef WDF_EXTERN_C_START enum _WDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS WDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS

WDF_CHILD_RETRIEVE_INFO

typedef struct _WDF_CHILD_RETRIEVE_INFO WDF_CHILD_RETRIEVE_INFO

WDF_RETRIEVE_CHILD_FLAGS

typedef enum _WDF_RETRIEVE_CHILD_FLAGS WDF_RETRIEVE_CHILD_FLAGS

Enumeration Type Documentation

_WDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS

enum _WDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS

Enumerator
WdfChildListRetrieveDeviceUndefined
WdfChildListRetrieveDeviceSuccess
WdfChildListRetrieveDeviceNotYetCreated
WdfChildListRetrieveDeviceNoSuchDevice

Definition at line 52 of file wdfchildlist.h.

                                                    {
    WdfChildListRetrieveDeviceUndefined = 0,
    WdfChildListRetrieveDeviceSuccess,
    WdfChildListRetrieveDeviceNotYetCreated,
    WdfChildListRetrieveDeviceNoSuchDevice,
} WDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS, *PWDF_CHILD_LIST_RETRIEVE_DEVICE_STATUS;

_WDF_RETRIEVE_CHILD_FLAGS

enum _WDF_RETRIEVE_CHILD_FLAGS

Enumerator
WdfRetrieveUnspecified
WdfRetrievePresentChildren
WdfRetrieveMissingChildren
WdfRetrievePendingChildren
WdfRetrieveAddedChildren
WdfRetrieveAllChildren

Definition at line 59 of file wdfchildlist.h.

                                       {
    WdfRetrieveUnspecified = 0x0000,
    WdfRetrievePresentChildren = 0x0001,
    WdfRetrieveMissingChildren = 0x0002,
    WdfRetrievePendingChildren = 0x0004,
    WdfRetrieveAddedChildren = (WdfRetrievePresentChildren | WdfRetrievePendingChildren),
    WdfRetrieveAllChildren = (WdfRetrievePresentChildren | WdfRetrievePendingChildren | WdfRetrieveMissingChildren),
} WDF_RETRIEVE_CHILD_FLAGS;

Function Documentation

_Function_class_() [1/10]

typedef _Function_class_

(

EVT_WDF_CHILD_LIST_CREATE_DEVICE

)

_Function_class_() [2/10]

typedef _Function_class_

(

EVT_WDF_CHILD_LIST_SCAN_FOR_CHILDREN

)

_Function_class_() [3/10]

typedef _Function_class_

(

EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COPY

)

_Function_class_() [4/10]

typedef _Function_class_

(

EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_DUPLICATE

)

_Function_class_() [5/10]

typedef _Function_class_

(

EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_COMPARE

)

_Function_class_() [6/10]

typedef _Function_class_

(

EVT_WDF_CHILD_LIST_IDENTIFICATION_DESCRIPTION_CLEANUP

)

_Function_class_() [7/10]

typedef _Function_class_

(

EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_COPY

)

_Function_class_() [8/10]

typedef _Function_class_

(

EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_DUPLICATE

)

_Function_class_() [9/10]

typedef _Function_class_

(

EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_CLEANUP

)

_Function_class_() [10/10]

typedef _Function_class_

(

EVT_WDF_CHILD_LIST_DEVICE_REENUMERATED

)

_IRQL_requires_max_() [1/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 64 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;
}

_IRQL_requires_max_() [2/2]

typedef _IRQL_requires_max_

(

DISPATCH_LEVEL

)

Definition at line 515 of file wdfchildlist.h.

{
    return ((PFN_WDFCHILDLISTGETDEVICE) WdfFunctions[WdfChildListGetDeviceTableIndex])(WdfDriverGlobals, ChildList);
}

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT()

FORCEINLINE VOID WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT	(	_Out_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER	Header,
		_In_ ULONG	AddressDescriptionSize
	)

Definition at line 105 of file wdfchildlist.h.

{
    RtlZeroMemory(Header, AddressDescriptionSize);
    Header->AddressDescriptionSize = AddressDescriptionSize;
}

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT()

FORCEINLINE VOID WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT	(	_Out_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER	Header,
		_In_ ULONG	IdentificationDescriptionSize
	)

Definition at line 83 of file wdfchildlist.h.

{
    RtlZeroMemory(Header, IdentificationDescriptionSize);
    Header->IdentificationDescriptionSize = IdentificationDescriptionSize;
}

WDF_CHILD_LIST_CONFIG_INIT()

FORCEINLINE VOID WDF_CHILD_LIST_CONFIG_INIT	(	_Out_ PWDF_CHILD_LIST_CONFIG	Config,
		_In_ ULONG	IdentificationDescriptionSize,
		_In_ PFN_WDF_CHILD_LIST_CREATE_DEVICE	EvtChildListCreateDevice
	)

Definition at line 415 of file wdfchildlist.h.

{
    RtlZeroMemory(Config, sizeof(WDF_CHILD_LIST_CONFIG));

    Config->Size = sizeof(WDF_CHILD_LIST_CONFIG);
    Config->IdentificationDescriptionSize = IdentificationDescriptionSize;
    Config->EvtChildListCreateDevice = EvtChildListCreateDevice;
}

Referenced by FxPkgFdo::Initialize().

WDF_CHILD_LIST_ITERATOR_INIT()

FORCEINLINE VOID WDF_CHILD_LIST_ITERATOR_INIT	(	_Out_ PWDF_CHILD_LIST_ITERATOR	Iterator,
		_In_ ULONG	Flags
	)

Definition at line 450 of file wdfchildlist.h.

{
    RtlZeroMemory(Iterator, sizeof(WDF_CHILD_LIST_ITERATOR));

    Iterator->Size = sizeof(WDF_CHILD_LIST_ITERATOR);
    Iterator->Flags = Flags;
}

WDF_CHILD_RETRIEVE_INFO_INIT()

FORCEINLINE VOID WDF_CHILD_RETRIEVE_INFO_INIT	(	_Out_ PWDF_CHILD_RETRIEVE_INFO	Info,
		_In_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER	IdentificationDescription
	)

Definition at line 309 of file wdfchildlist.h.

{
    RtlZeroMemory(Info, sizeof(WDF_CHILD_RETRIEVE_INFO));

    Info->Size = sizeof(WDF_CHILD_RETRIEVE_INFO);
    Info->IdentificationDescription = IdentificationDescription;
}