wdfregistry.h File Reference

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

Go to the source code of this file.

Macros
#define	WDF_EXTERN_C
#define	WDF_EXTERN_C_START
#define	WDF_EXTERN_C_END
#define	WDF_REGKEY_DEVICE_SUBKEY   0
#define	WDF_REGKEY_DRIVER_SUBKEY   0

Typedefs
typedef _Must_inspect_result_	_IRQL_requires_max_(PASSIVE_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFREGISTRYOPENKEY) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_opt_ WDFKEY	ParentKey
typedef _Must_inspect_result_ _In_opt_ WDFKEY _In_ PCUNICODE_STRING	KeyName
typedef _Must_inspect_result_ _In_opt_ WDFKEY _In_ PCUNICODE_STRING _In_ ACCESS_MASK	DesiredAccess
typedef _Must_inspect_result_ _In_opt_ WDFKEY _In_ PCUNICODE_STRING _In_ ACCESS_MASK _In_opt_ PWDF_OBJECT_ATTRIBUTES	KeyAttributes
typedef _Must_inspect_result_ _In_opt_ WDFKEY _In_ PCUNICODE_STRING _In_ ACCESS_MASK _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFKEY *	Key
typedef _Must_inspect_result_ _In_opt_ WDFKEY _In_ PCUNICODE_STRING _In_ ACCESS_MASK _In_ ULONG	CreateOptions
typedef _Must_inspect_result_ _In_opt_ WDFKEY _In_ PCUNICODE_STRING _In_ ACCESS_MASK _In_ ULONG _Out_opt_ PULONG	CreateDisposition
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING	ValueName
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ ULONG	ValueLength
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ ULONG	_Out_writes_bytes_opt_(ValueLength) PVOID Value
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ ULONG _Out_opt_ PULONG	ValueLengthQueried
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ ULONG _Out_opt_ PULONG _Out_opt_ PULONG	ValueType
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ _Strict_type_match_ POOL_TYPE	PoolType
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ _Strict_type_match_ POOL_TYPE _In_opt_ PWDF_OBJECT_ATTRIBUTES	MemoryAttributes
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ _Strict_type_match_ POOL_TYPE _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFMEMORY *	Memory
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_opt_ PWDF_OBJECT_ATTRIBUTES	StringsAttributes
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ WDFCOLLECTION	Collection
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _Out_opt_ PUSHORT	ValueByteLength
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _Out_opt_ PUSHORT _Inout_opt_ PUNICODE_STRING	Value
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ WDFSTRING	String
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ ULONG _In_ ULONG	_In_reads_(ValueLength) PVOID Value)
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ ULONG _In_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET	MemoryOffsets
typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ WDFCOLLECTION	StringsCollection

Functions
_Must_inspect_result_	_IRQL_requires_max_ (PASSIVE_LEVEL) FORCEINLINE NTSTATUS WdfRegistryOpenKey(_In_opt_ WDFKEY ParentKey
	Queries information details about a security descriptor. More...
_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ ULONG	_Out_writes_bytes_opt_ (ValueLength) PVOID Value
_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ ULONG _In_ ULONG	_In_reads_ (ValueLength) PVOID Value)

Macro Definition Documentation

WDF_EXTERN_C

#define WDF_EXTERN_C

Definition at line 38 of file wdfregistry.h.

WDF_EXTERN_C_END

#define WDF_EXTERN_C_END

Definition at line 40 of file wdfregistry.h.

WDF_EXTERN_C_START

#define WDF_EXTERN_C_START

Definition at line 39 of file wdfregistry.h.

WDF_REGKEY_DEVICE_SUBKEY

#define WDF_REGKEY_DEVICE_SUBKEY   0

Definition at line 50 of file wdfregistry.h.

WDF_REGKEY_DRIVER_SUBKEY

#define WDF_REGKEY_DRIVER_SUBKEY   0

Definition at line 51 of file wdfregistry.h.

Typedef Documentation

_In_reads_

typedef _Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ ULONG _In_ ULONG _In_reads_(ValueLength) PVOID Value)

Definition at line 522 of file wdfregistry.h.

_IRQL_requires_max_

typedef _Must_inspect_result_ _IRQL_requires_max_(PASSIVE_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFREGISTRYASSIGNULONG)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals

Definition at line 62 of file wdfregistry.h.

_Out_writes_bytes_opt_

_In_opt_ HANDLE _In_opt_ PIO_APC_ROUTINE _In_opt_ PVOID _Out_ PIO_STATUS_BLOCK _In_ ULONG _In_ ULONG _Out_writes_bytes_opt_

Definition at line 276 of file wdfregistry.h.

Collection

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ WDFCOLLECTION Collection

Initial value:

{
    return ((PFN_WDFREGISTRYQUERYMULTISTRING) WdfFunctions[WdfRegistryQueryMultiStringTableIndex])(WdfDriverGlobals, Key, ValueName, StringsAttributes, Collection)

Definition at line 367 of file wdfregistry.h.

CreateDisposition

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ ACCESS_MASK _In_ ULONG _Out_opt_ PULONG CreateDisposition

Definition at line 112 of file wdfregistry.h.

CreateOptions

_In_ ACCESS_MASK _In_ HANDLE _In_ HANDLE _In_opt_ POBJECT_ATTRIBUTES _In_opt_ ULONG CreateOptions

Definition at line 112 of file wdfregistry.h.

DesiredAccess

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ ACCESS_MASK DesiredAccess

Definition at line 69 of file wdfregistry.h.

Key

typedef _Must_inspect_result_ _In_ WDFKEY Key

Initial value:

{
    return ((PFN_WDFREGISTRYOPENKEY) WdfFunctions[WdfRegistryOpenKeyTableIndex])(WdfDriverGlobals, ParentKey, KeyName, DesiredAccess, KeyAttributes, Key)

Definition at line 69 of file wdfregistry.h.

KeyAttributes

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ ACCESS_MASK _In_ ULONG _Out_opt_ PULONG _In_opt_ PWDF_OBJECT_ATTRIBUTES KeyAttributes

Definition at line 69 of file wdfregistry.h.

KeyName

_Must_inspect_result_ _In_ PCUNICODE_STRING KeyName

Definition at line 69 of file wdfregistry.h.

Memory

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ ULONG _In_ WDFMEMORY Memory

Definition at line 318 of file wdfregistry.h.

MemoryAttributes

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ _Strict_type_match_ POOL_TYPE _In_opt_ PWDF_OBJECT_ATTRIBUTES MemoryAttributes

Definition at line 318 of file wdfregistry.h.

MemoryOffsets

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ ULONG _In_ WDFMEMORY _In_opt_ PWDFMEMORY_OFFSET MemoryOffsets

Initial value:

{
    return ((PFN_WDFREGISTRYASSIGNMEMORY) WdfFunctions[WdfRegistryAssignMemoryTableIndex])(WdfDriverGlobals, Key, ValueName, ValueType, Memory, MemoryOffsets)

Definition at line 558 of file wdfregistry.h.

ParentKey

_Must_inspect_result_ _In_opt_ WDFKEY ParentKey

Definition at line 69 of file wdfregistry.h.

PoolType

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ _Strict_type_match_ POOL_TYPE PoolType

Definition at line 318 of file wdfregistry.h.

String

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ WDFSTRING String

Initial value:

{
    return ((PFN_WDFREGISTRYQUERYSTRING) WdfFunctions[WdfRegistryQueryStringTableIndex])(WdfDriverGlobals, Key, ValueName, String)

Definition at line 445 of file wdfregistry.h.

StringsAttributes

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_opt_ PWDF_OBJECT_ATTRIBUTES StringsAttributes

Definition at line 367 of file wdfregistry.h.

StringsCollection

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ WDFCOLLECTION StringsCollection

Initial value:

{
    return ((PFN_WDFREGISTRYASSIGNMULTISTRING) WdfFunctions[WdfRegistryAssignMultiStringTableIndex])(WdfDriverGlobals, Key, ValueName, StringsCollection)

Definition at line 601 of file wdfregistry.h.

Value

_Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ ULONG Value

Initial value:

{
    return ((PFN_WDFREGISTRYQUERYUNICODESTRING) WdfFunctions[WdfRegistryQueryUnicodeStringTableIndex])(WdfDriverGlobals, Key, ValueName, ValueByteLength, Value)

Definition at line 406 of file wdfregistry.h.

ValueByteLength

_Must_inspect_result_ _In_ PCUNICODE_STRING _Out_opt_ PUSHORT ValueByteLength

Definition at line 406 of file wdfregistry.h.

ValueLength

_Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ ULONG _In_ ULONG ValueLength

Definition at line 271 of file wdfregistry.h.

ValueLengthQueried

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ ULONG _Out_opt_ PULONG ValueLengthQueried

Definition at line 279 of file wdfregistry.h.

ValueName

_Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING ValueName

Initial value:

{
    return ((PFN_WDFREGISTRYREMOVEVALUE) WdfFunctions[WdfRegistryRemoveValueTableIndex])(WdfDriverGlobals, Key, ValueName)

Definition at line 240 of file wdfregistry.h.

ValueType

_Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ ULONG ValueType

Initial value:

{
    return ((PFN_WDFREGISTRYQUERYVALUE) WdfFunctions[WdfRegistryQueryValueTableIndex])(WdfDriverGlobals, Key, ValueName, ValueLength, Value, ValueLengthQueried, ValueType)

Definition at line 279 of file wdfregistry.h.

Function Documentation

_In_reads_()

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ ULONG _In_ ULONG _In_reads_

(

ValueLength

)

Definition at line 539 of file wdfregistry.h.

{
    return ((PFN_WDFREGISTRYASSIGNVALUE) WdfFunctions[WdfRegistryAssignValueTableIndex])(WdfDriverGlobals, Key, ValueName, ValueType, ValueLength, Value);
}

_IRQL_requires_max_()

_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 165 of file wdfregistry.h.

{
    ((PFN_WDFREGISTRYCLOSE) WdfFunctions[WdfRegistryCloseTableIndex])(WdfDriverGlobals, Key);
}

_Out_writes_bytes_opt_()

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ ULONG _Out_writes_bytes_opt_

(

ValueLength

)