wdfwmi.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_WMI_PROVIDER_CONFIG
struct	_WDF_WMI_INSTANCE_CONFIG

Macros
#define	WDF_EXTERN_C
#define	WDF_EXTERN_C_START
#define	WDF_EXTERN_C_END

Typedefs
typedef WDF_EXTERN_C_START enum _WDF_WMI_PROVIDER_CONTROL	WDF_WMI_PROVIDER_CONTROL
typedef enum _WDF_WMI_PROVIDER_FLAGS	WDF_WMI_PROVIDER_FLAGS
typedef _In_ ULONG	OutBufferSize
typedef _In_ ULONG	_Out_writes_bytes_to_(OutBufferSize, *BufferUsed) PVOID OutBuffer
typedef _In_ ULONG _Out_ PULONG	BufferUsed
typedef EVT_WDF_WMI_INSTANCE_QUERY_INSTANCE *	PFN_WDF_WMI_INSTANCE_QUERY_INSTANCE
typedef _In_ ULONG	InBufferSize
typedef _In_ ULONG	_In_reads_bytes_(InBufferSize) PVOID InBuffer)
typedef EVT_WDF_WMI_INSTANCE_SET_INSTANCE *	PFN_WDF_WMI_INSTANCE_SET_INSTANCE
typedef _In_ ULONG	DataItemId
typedef EVT_WDF_WMI_INSTANCE_SET_ITEM *	PFN_WDF_WMI_INSTANCE_SET_ITEM
typedef _In_ ULONG	MethodId
typedef _In_ ULONG _In_ ULONG _In_ ULONG	_When_(InBufferSize >=OutBufferSize, _Inout_updates_bytes_(InBufferSize)) _When_(InBufferSize< OutBufferSize
typedef _In_ ULONG _In_ ULONG _In_ ULONG	_Inout_updates_bytes_(OutBufferSize)) PVOID Buffer
typedef EVT_WDF_WMI_INSTANCE_EXECUTE_METHOD *	PFN_WDF_WMI_INSTANCE_EXECUTE_METHOD
typedef _In_ WDF_WMI_PROVIDER_CONTROL	Control
typedef _In_ WDF_WMI_PROVIDER_CONTROL _In_ BOOLEAN	Enable
typedef EVT_WDF_WMI_PROVIDER_FUNCTION_CONTROL *	PFN_WDF_WMI_PROVIDER_FUNCTION_CONTROL
typedef struct _WDF_WMI_PROVIDER_CONFIG	WDF_WMI_PROVIDER_CONFIG
typedef struct _WDF_WMI_PROVIDER_CONFIG *	PWDF_WMI_PROVIDER_CONFIG
typedef struct _WDF_WMI_INSTANCE_CONFIG	WDF_WMI_INSTANCE_CONFIG
typedef struct _WDF_WMI_INSTANCE_CONFIG *	PWDF_WMI_INSTANCE_CONFIG
typedef _Must_inspect_result_	_IRQL_requires_max_(DISPATCH_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFWMIPROVIDERCREATE) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_ WDFDEVICE	Device
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_WMI_PROVIDER_CONFIG	WmiProviderConfig
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_WMI_PROVIDER_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES	ProviderAttributes
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_WMI_PROVIDER_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFWMIPROVIDER *	WmiProvider
typedef _In_ WDFWMIPROVIDER _In_ WDF_WMI_PROVIDER_CONTROL	ProviderControl
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_WMI_INSTANCE_CONFIG	InstanceConfig
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_WMI_INSTANCE_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES	InstanceAttributes
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_WMI_INSTANCE_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_opt_ WDFWMIINSTANCE *	Instance
typedef _Must_inspect_result_ _In_ WDFWMIINSTANCE	WmiInstance
typedef _Must_inspect_result_ _In_ WDFWMIINSTANCE _In_opt_ ULONG	EventDataSize
typedef _Must_inspect_result_ _In_ WDFWMIINSTANCE _In_opt_ ULONG	_In_reads_bytes_opt_(EventDataSize) PVOID EventData)

Enumerations
enum	_WDF_WMI_PROVIDER_CONTROL { WdfWmiControlInvalid = 0 , WdfWmiEventControl , WdfWmiInstanceControl }
enum	_WDF_WMI_PROVIDER_FLAGS { WdfWmiProviderEventOnly = 0x0001 , WdfWmiProviderExpensive = 0x0002 , WdfWmiProviderTracing = 0x0004 , WdfWmiProviderValidFlags = WdfWmiProviderEventOnly | WdfWmiProviderExpensive | WdfWmiProviderTracing }

Functions
typedef	_Function_class_ (EVT_WDF_WMI_INSTANCE_QUERY_INSTANCE) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_WMI_INSTANCE_QUERY_INSTANCE(_In_ WDFWMIINSTANCE WmiInstance
typedef	_Function_class_ (EVT_WDF_WMI_INSTANCE_SET_INSTANCE) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_WMI_INSTANCE_SET_INSTANCE(_In_ WDFWMIINSTANCE WmiInstance
typedef	_Function_class_ (EVT_WDF_WMI_INSTANCE_SET_ITEM) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_WMI_INSTANCE_SET_ITEM(_In_ WDFWMIINSTANCE WmiInstance
typedef	_Function_class_ (EVT_WDF_WMI_INSTANCE_EXECUTE_METHOD) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_WMI_INSTANCE_EXECUTE_METHOD(_In_ WDFWMIINSTANCE WmiInstance
typedef	_Function_class_ (EVT_WDF_WMI_PROVIDER_FUNCTION_CONTROL) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_WMI_PROVIDER_FUNCTION_CONTROL(_In_ WDFWMIPROVIDER WmiProvider
FORCEINLINE VOID	WDF_WMI_PROVIDER_CONFIG_INIT (_Out_ PWDF_WMI_PROVIDER_CONFIG Config, _In_ CONST GUID *Guid)
FORCEINLINE VOID	WDF_WMI_INSTANCE_CONFIG_INIT_PROVIDER (_Out_ PWDF_WMI_INSTANCE_CONFIG Config, _In_ WDFWMIPROVIDER Provider)
FORCEINLINE VOID	WDF_WMI_INSTANCE_CONFIG_INIT_PROVIDER_CONFIG (_Out_ PWDF_WMI_INSTANCE_CONFIG Config, _In_ PWDF_WMI_PROVIDER_CONFIG ProviderConfig)
FORCEINLINE NTSTATUS	WDF_WMI_BUFFER_APPEND_STRING (_Out_writes_bytes_(BufferLength) PVOID Buffer, _In_ ULONG BufferLength, _In_ PCUNICODE_STRING String, _Out_ PULONG RequiredSize)
_Must_inspect_result_	_IRQL_requires_max_ (PASSIVE_LEVEL) FORCEINLINE NTSTATUS WdfWmiInstanceRegister(_In_ WDFWMIINSTANCE WmiInstance)
	Queries information details about a security descriptor.
_Must_inspect_result_	_IRQL_requires_max_ (APC_LEVEL) FORCEINLINE NTSTATUS WdfWmiInstanceFireEvent(_In_ WDFWMIINSTANCE WmiInstance
	Probes and locks virtual pages in memory for the specified process.

Macro Definition Documentation

WDF_EXTERN_C

#define WDF_EXTERN_C

Definition at line 38 of file wdfwmi.h.

WDF_EXTERN_C_END

#define WDF_EXTERN_C_END

Definition at line 40 of file wdfwmi.h.

WDF_EXTERN_C_START

#define WDF_EXTERN_C_START

Definition at line 39 of file wdfwmi.h.

Typedef Documentation

_In_reads_bytes_

typedef _In_ ULONG _In_ ULONG _In_reads_bytes_(InBufferSize) PVOID InBuffer)

Definition at line 107 of file wdfwmi.h.

_In_reads_bytes_opt_

typedef _Must_inspect_result_ _In_ WDFWMIINSTANCE _In_opt_ ULONG _In_reads_bytes_opt_(EventDataSize) PVOID EventData)

Definition at line 618 of file wdfwmi.h.

_Inout_updates_bytes_

typedef _In_ ULONG _In_ ULONG _In_ ULONG _Inout_updates_bytes_(OutBufferSize)) PVOID Buffer

Definition at line 148 of file wdfwmi.h.

_IRQL_requires_max_

typedef _Must_inspect_result_ _IRQL_requires_max_(APC_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFWMIINSTANCEFIREEVENT)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals

Definition at line 349 of file wdfwmi.h.

_Out_writes_bytes_to_

_Out_writes_bytes_to_

Definition at line 88 of file wdfwmi.h.

_When_

typedef _In_ ULONG _In_ ULONG _In_ ULONG _When_(InBufferSize >=OutBufferSize, _Inout_updates_bytes_(InBufferSize)) _When_(InBufferSize< OutBufferSize

Definition at line 147 of file wdfwmi.h.

BufferUsed

typedef _Must_inspect_result_ __drv_sameIRQL __in FxWmiInstanceInternal __in ULONG __in ULONG __inout ULONG __out PULONG BufferUsed

Definition at line 91 of file wdfwmi.h.

Control

MIXER_STATUS Control

Definition at line 166 of file wdfwmi.h.

DataItemId

typedef _In_ ULONG DataItemId

Definition at line 123 of file wdfwmi.h.

Device

typedef _Must_inspect_result_ _In_ WDFDEVICE Device

Definition at line 356 of file wdfwmi.h.

Enable

typedef _In_ WDF_WMI_PROVIDER_CONTROL _In_ BOOLEAN Enable

Definition at line 168 of file wdfwmi.h.

EventDataSize

_Must_inspect_result_ _In_opt_ ULONG EventDataSize

Definition at line 617 of file wdfwmi.h.

InBufferSize

typedef _Must_inspect_result_ __drv_sameIRQL __in FxWmiInstanceInternal __in ULONG __in ULONG InBufferSize

Definition at line 106 of file wdfwmi.h.

Instance

typedef _Must_inspect_result_ __drv_sameIRQL __in FxWmiInstanceInternal * Instance

Initial value:

{
    return ((PFN_WDFWMIINSTANCECREATE) WdfFunctions[WdfWmiInstanceCreateTableIndex])(WdfDriverGlobals, Device, InstanceConfig, InstanceAttributes, Instance)

Definition at line 480 of file wdfwmi.h.

InstanceAttributes

_Must_inspect_result_ _In_ PWDF_WMI_INSTANCE_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES InstanceAttributes

Definition at line 478 of file wdfwmi.h.

InstanceConfig

_Must_inspect_result_ _In_ PWDF_WMI_INSTANCE_CONFIG InstanceConfig

Definition at line 476 of file wdfwmi.h.

MethodId

typedef _In_ ULONG MethodId

Definition at line 142 of file wdfwmi.h.

OutBufferSize

typedef _Must_inspect_result_ __drv_sameIRQL __in FxWmiInstanceInternal __in ULONG __in ULONG __inout ULONG OutBufferSize

Definition at line 87 of file wdfwmi.h.

PFN_WDF_WMI_INSTANCE_EXECUTE_METHOD

typedef EVT_WDF_WMI_INSTANCE_EXECUTE_METHOD* PFN_WDF_WMI_INSTANCE_EXECUTE_METHOD

Definition at line 154 of file wdfwmi.h.

PFN_WDF_WMI_INSTANCE_QUERY_INSTANCE

typedef EVT_WDF_WMI_INSTANCE_QUERY_INSTANCE* PFN_WDF_WMI_INSTANCE_QUERY_INSTANCE

Definition at line 94 of file wdfwmi.h.

PFN_WDF_WMI_INSTANCE_SET_INSTANCE

typedef EVT_WDF_WMI_INSTANCE_SET_INSTANCE* PFN_WDF_WMI_INSTANCE_SET_INSTANCE

Definition at line 111 of file wdfwmi.h.

PFN_WDF_WMI_INSTANCE_SET_ITEM

typedef EVT_WDF_WMI_INSTANCE_SET_ITEM* PFN_WDF_WMI_INSTANCE_SET_ITEM

Definition at line 130 of file wdfwmi.h.

PFN_WDF_WMI_PROVIDER_FUNCTION_CONTROL

typedef EVT_WDF_WMI_PROVIDER_FUNCTION_CONTROL* PFN_WDF_WMI_PROVIDER_FUNCTION_CONTROL

Definition at line 171 of file wdfwmi.h.

ProviderAttributes

_Must_inspect_result_ _In_ PWDF_WMI_PROVIDER_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES ProviderAttributes

Definition at line 360 of file wdfwmi.h.

ProviderControl

_In_ WDF_WMI_PROVIDER_CONTROL ProviderControl

Initial value:

{
    return ((PFN_WDFWMIPROVIDERISENABLED) WdfFunctions[WdfWmiProviderIsEnabledTableIndex])(WdfDriverGlobals, WmiProvider, ProviderControl)

Definition at line 421 of file wdfwmi.h.

PWDF_WMI_INSTANCE_CONFIG

typedef struct _WDF_WMI_INSTANCE_CONFIG * PWDF_WMI_INSTANCE_CONFIG

PWDF_WMI_PROVIDER_CONFIG

typedef struct _WDF_WMI_PROVIDER_CONFIG * PWDF_WMI_PROVIDER_CONFIG

WDF_WMI_INSTANCE_CONFIG

typedef struct _WDF_WMI_INSTANCE_CONFIG WDF_WMI_INSTANCE_CONFIG

WDF_WMI_PROVIDER_CONFIG

typedef struct _WDF_WMI_PROVIDER_CONFIG WDF_WMI_PROVIDER_CONFIG

WDF_WMI_PROVIDER_CONTROL

typedef WDF_EXTERN_C_START enum _WDF_WMI_PROVIDER_CONTROL WDF_WMI_PROVIDER_CONTROL

WDF_WMI_PROVIDER_FLAGS

typedef enum _WDF_WMI_PROVIDER_FLAGS WDF_WMI_PROVIDER_FLAGS

WmiInstance

_Must_inspect_result_ _In_ WDFWMIINSTANCE WmiInstance

Initial value:

{
    FxWmiInstanceExternal* pInstance

Definition at line 513 of file wdfwmi.h.

WmiProvider

_In_ WDFWMIPROVIDER WmiProvider

Initial value:

{
    return ((PFN_WDFWMIPROVIDERCREATE) WdfFunctions[WdfWmiProviderCreateTableIndex])(WdfDriverGlobals, Device, WmiProviderConfig, ProviderAttributes, WmiProvider)

Definition at line 362 of file wdfwmi.h.

WmiProviderConfig

_Must_inspect_result_ _In_ PWDF_WMI_PROVIDER_CONFIG WmiProviderConfig

Definition at line 358 of file wdfwmi.h.

Enumeration Type Documentation

_WDF_WMI_PROVIDER_CONTROL

enum _WDF_WMI_PROVIDER_CONTROL

Enumerator
WdfWmiControlInvalid
WdfWmiEventControl
WdfWmiInstanceControl

Definition at line 50 of file wdfwmi.h.

                                       {
    WdfWmiControlInvalid = 0,
    WdfWmiEventControl,
    WdfWmiInstanceControl,
} WDF_WMI_PROVIDER_CONTROL;

_WDF_WMI_PROVIDER_FLAGS

enum _WDF_WMI_PROVIDER_FLAGS

Enumerator
WdfWmiProviderEventOnly
WdfWmiProviderExpensive
WdfWmiProviderTracing
WdfWmiProviderValidFlags

Definition at line 68 of file wdfwmi.h.

                                     {
    WdfWmiProviderEventOnly = 0x0001,
    WdfWmiProviderExpensive = 0x0002,
    WdfWmiProviderTracing =   0x0004,
    WdfWmiProviderValidFlags = WdfWmiProviderEventOnly | WdfWmiProviderExpensive | WdfWmiProviderTracing,
} WDF_WMI_PROVIDER_FLAGS;

Function Documentation

_Function_class_() [1/5]

typedef _Function_class_

(

EVT_WDF_WMI_INSTANCE_EXECUTE_METHOD

)

_Function_class_() [2/5]

typedef _Function_class_

(

EVT_WDF_WMI_INSTANCE_QUERY_INSTANCE

)

_Function_class_() [3/5]

typedef _Function_class_

(

EVT_WDF_WMI_INSTANCE_SET_INSTANCE

)

_Function_class_() [4/5]

typedef _Function_class_

(

EVT_WDF_WMI_INSTANCE_SET_ITEM

)

_Function_class_() [5/5]

typedef _Function_class_

(

EVT_WDF_WMI_PROVIDER_FUNCTION_CONTROL

)

_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 37 of file cddata.c.

{
    THREAD_CONTEXT ThreadContext = {0};
    PIRP_CONTEXT IrpContext = NULL;
    BOOLEAN Wait;
 
#ifdef CD_SANITY
    PVOID PreviousTopLevel;
#endif
 
    NTSTATUS Status;
 
#if DBG
 
    KIRQL SaveIrql = KeGetCurrentIrql();
 
#endif
 
    ASSERT_OPTIONAL_IRP( Irp );
 
    UNREFERENCED_PARAMETER( DeviceObject );
 
    FsRtlEnterFileSystem();
 
#ifdef CD_SANITY
    PreviousTopLevel = IoGetTopLevelIrp();
#endif
 
    //
    //  Loop until this request has been completed or posted.
    //
 
    do {
 
        //
        //  Use a try-except to handle the exception cases.
        //
 
        _SEH2_TRY {
 
            //
            //  If the IrpContext is NULL then this is the first pass through
            //  this loop.
            //
 
            if (IrpContext == NULL) {
 
                //
                //  Decide if this request is waitable an allocate the IrpContext.
                //  If the file object in the stack location is NULL then this
                //  is a mount which is always waitable.  Otherwise we look at
                //  the file object flags.
                //
 
                if (IoGetCurrentIrpStackLocation( Irp )->FileObject == NULL) {
 
                    Wait = TRUE;
 
                } else {
 
                    Wait = CanFsdWait( Irp );
                }
 
                IrpContext = CdCreateIrpContext( Irp, Wait );
 
                //
                //  Update the thread context information.
                //
 
                CdSetThreadContext( IrpContext, &ThreadContext );
 
#ifdef CD_SANITY
                NT_ASSERT( !CdTestTopLevel ||
                        SafeNodeType( IrpContext->TopLevel ) == CDFS_NTC_IRP_CONTEXT );
#endif
 
            //
            //  Otherwise cleanup the IrpContext for the retry.
            //
 
            } else {
 
                //
                //  Set the MORE_PROCESSING flag to make sure the IrpContext
                //  isn't inadvertently deleted here.  Then cleanup the
                //  IrpContext to perform the retry.
                //
 
                SetFlag( IrpContext->Flags, IRP_CONTEXT_FLAG_MORE_PROCESSING );
                CdCleanupIrpContext( IrpContext, FALSE );
            }
 
            //
            //  Case on the major irp code.
            //
 
            switch (IrpContext->MajorFunction) {
 
            case IRP_MJ_CREATE :
 
                Status = CdCommonCreate( IrpContext, Irp );
                break;
 
            case IRP_MJ_CLOSE :
 
                Status = CdCommonClose( IrpContext, Irp );
                break;
 
            case IRP_MJ_READ :
 
                //
                //  If this is an Mdl complete request, don't go through
                //  common read.
                //
 
                if (FlagOn( IrpContext->MinorFunction, IRP_MN_COMPLETE )) {
 
                    Status = CdCompleteMdl( IrpContext, Irp );
 
                } else {
 
                    Status = CdCommonRead( IrpContext, Irp );
                }
 
                break;
 
            case IRP_MJ_WRITE :
 
                Status = CdCommonWrite( IrpContext, Irp );
                break;
 
            case IRP_MJ_QUERY_INFORMATION :
 
                Status = CdCommonQueryInfo( IrpContext, Irp );
                break;
 
            case IRP_MJ_SET_INFORMATION :
 
                Status = CdCommonSetInfo( IrpContext, Irp );
                break;
 
            case IRP_MJ_QUERY_VOLUME_INFORMATION :
 
                Status = CdCommonQueryVolInfo( IrpContext, Irp );
                break;
 
            case IRP_MJ_DIRECTORY_CONTROL :
 
                Status = CdCommonDirControl( IrpContext, Irp );
                break;
 
            case IRP_MJ_FILE_SYSTEM_CONTROL :
 
                Status = CdCommonFsControl( IrpContext, Irp );
                break;
 
            case IRP_MJ_DEVICE_CONTROL :
 
                Status = CdCommonDevControl( IrpContext, Irp );
                break;
 
            case IRP_MJ_LOCK_CONTROL :
 
                Status = CdCommonLockControl( IrpContext, Irp );
                break;
 
            case IRP_MJ_CLEANUP :
 
                Status = CdCommonCleanup( IrpContext, Irp );
                break;
 
            case IRP_MJ_PNP :
 
                Status = CdCommonPnp( IrpContext, Irp );
                break;
 
            case IRP_MJ_SHUTDOWN :
 
                Status = CdCommonShutdown( IrpContext, Irp );
                break;
 
            default :
 
                Status = STATUS_INVALID_DEVICE_REQUEST;
                CdCompleteRequest( IrpContext, Irp, Status );
            }
 
        } _SEH2_EXCEPT( CdExceptionFilter( IrpContext, _SEH2_GetExceptionInformation() )) {
 
            Status = CdProcessException( IrpContext, Irp, _SEH2_GetExceptionCode() );
        } _SEH2_END;
 
    } while (Status == STATUS_CANT_WAIT);
 
#ifdef CD_SANITY
    NT_ASSERT( !CdTestTopLevel ||
            (PreviousTopLevel == IoGetTopLevelIrp()) );
#endif
 
    FsRtlExitFileSystem();
 
    NT_ASSERT( SaveIrql == KeGetCurrentIrql( ));
 
    return Status;
}

_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 517 of file wdfwmi.h.

{
    return ((PFN_WDFWMIINSTANCEREGISTER) WdfFunctions[WdfWmiInstanceRegisterTableIndex])(WdfDriverGlobals, WmiInstance);
}

WDF_WMI_BUFFER_APPEND_STRING()

FORCEINLINE NTSTATUS WDF_WMI_BUFFER_APPEND_STRING	(	_Out_writes_bytes_(BufferLength) PVOID	Buffer,
		_In_ ULONG	BufferLength,
		_In_ PCUNICODE_STRING	String,
		_Out_ PULONG	RequiredSize
	)

Definition at line 299 of file wdfwmi.h.

{
    //
    // Compute the length of buffer we need to use.  Upon error the caller can
    // use this length to report the required length.  On success, the caller
    // can use this length to know how many bytes were written.
    //
    *RequiredSize = String->Length + sizeof(USHORT);
 
    //
    // UNICODE_STRING.Length is the length of the string in bytes, not characters
    //
 
    // First check to see if there is enough space
    // 1)  to store the length of the string
    // 2)  to store the string itself
    //
    if (BufferLength < (String->Length + sizeof(USHORT))) {
        //
        // Not enough room in the string, report back how big a buffer is
        // required.
        //
        return STATUS_BUFFER_TOO_SMALL;
    }
 
    //
    // Store the length of the string
    //
    *(USHORT *) Buffer = String->Length;
 
    //
    // Copy the string to the buffer
    //
    RtlCopyMemory(WDF_PTR_ADD_OFFSET(Buffer, sizeof(USHORT)),
                  String->Buffer,
                  String->Length);
 
    return STATUS_SUCCESS;
}

WDF_WMI_INSTANCE_CONFIG_INIT_PROVIDER()

FORCEINLINE VOID WDF_WMI_INSTANCE_CONFIG_INIT_PROVIDER	(	_Out_ PWDF_WMI_INSTANCE_CONFIG	Config,
		_In_ WDFWMIPROVIDER	Provider
	)

Definition at line 273 of file wdfwmi.h.

{
    RtlZeroMemory(Config, sizeof(WDF_WMI_INSTANCE_CONFIG));
    Config->Size = sizeof(WDF_WMI_INSTANCE_CONFIG);
 
    Config->Provider = Provider;
}

WDF_WMI_INSTANCE_CONFIG_INIT_PROVIDER_CONFIG()

FORCEINLINE VOID WDF_WMI_INSTANCE_CONFIG_INIT_PROVIDER_CONFIG	(	_Out_ PWDF_WMI_INSTANCE_CONFIG	Config,
		_In_ PWDF_WMI_PROVIDER_CONFIG	ProviderConfig
	)

Definition at line 286 of file wdfwmi.h.

{
    RtlZeroMemory(Config, sizeof(WDF_WMI_INSTANCE_CONFIG));
    Config->Size = sizeof(WDF_WMI_INSTANCE_CONFIG);
 
    Config->ProviderConfig = ProviderConfig;
}

WDF_WMI_PROVIDER_CONFIG_INIT()

FORCEINLINE VOID WDF_WMI_PROVIDER_CONFIG_INIT	(	_Out_ PWDF_WMI_PROVIDER_CONFIG	Config,
		_In_ CONST GUID *	Guid
	)

Definition at line 205 of file wdfwmi.h.

{
    RtlZeroMemory(Config, sizeof(WDF_WMI_PROVIDER_CONFIG));
 
    Config->Size = sizeof(WDF_WMI_PROVIDER_CONFIG);
    RtlCopyMemory(&Config->Guid, Guid, sizeof(GUID));
}