ZwNotifyChangeKey function (ntifs.h)
The ZwNotifyChangeKey routine allows a driver to request notification when a registry key changes.
Syntax
NTSYSAPI NTSTATUS ZwNotifyChangeKey(
[in] HANDLE KeyHandle,
[in, optional] HANDLE Event,
[in, optional] PIO_APC_ROUTINE ApcRoutine,
[in, optional] PVOID ApcContext,
[out] PIO_STATUS_BLOCK IoStatusBlock,
[in] ULONG CompletionFilter,
[in] BOOLEAN WatchTree,
[out, optional] PVOID Buffer,
[in] ULONG BufferSize,
[in] BOOLEAN Asynchronous
);
Parameters
[in] KeyHandle
Handle to the key to register a notification routine for. This handle is created by a successful call to ZwCreateKey or ZwOpenKey. The caller must have specified KEY_NOTIFY access.
[in, optional] Event
Optional handle to a caller-created event to be set to the Signaled state when the operation completes. If not NULL, the caller is placed into a wait state until the operation succeeds, at which time the event is set to the Signaled state.
[in, optional] ApcRoutine
Pointer to a caller-supplied APC routine to run after the operation completes. This parameter is optional and can be NULL.
[in, optional] ApcContext
Pointer to pass as an argument to the APC routine that ApcRoutine points to. This argument is required if ApcRoutine isn't NULL, and must be cast to type PVOID. Otherwise, if ApcRoutine is NULL, set this parameter to NULL, too.
The meaning of this parameter depends on whether the routine is called from kernel mode or from user mode:
For a kernel-mode call, set this parameter to one of the following WORK_QUEUE_TYPE enumeration values:
- CriticalWorkQueue
- DelayedWorkQueue
For a user-mode call, this parameter points to a caller-specified context for the APC routine.
[out] IoStatusBlock
Pointer to an IO_STATUS_BLOCK structure that contains the final status and information about the operation. For successful calls that return data, the number of bytes written to Buffer is supplied in IoStatusBlock->Information.
[in] CompletionFilter
Bitmask of operations that cause the driver to be notified. Specify one or more of the following flags:
| Value | Meaning |
|---|---|
| REG_NOTIFY_CHANGE_NAME | Notify the caller if a subkey is added or deleted. |
| REG_NOTIFY_CHANGE_ATTRIBUTES | Notify the caller of changes to the attributes of the key, such as the security descriptor information. |
| REG_NOTIFY_CHANGE_LAST_SET | Notify the caller of changes to a value of the key. This can include adding or deleting a value, or changing an existing value. (The caller receives no notification if the new value written to the key matches the previous value of the key.) |
| REG_NOTIFY_CHANGE_SECURITY | Notify the caller of changes to the security descriptor of the key. |
[in] WatchTree
If TRUE, the driver is notified about changes to all subkeys of the specified key. If FALSE, the driver is only notified for changes to the specified key.
[out, optional] Buffer
Reserved. Specify NULL.
[in] BufferSize
Reserved. Specify zero.
[in] Asynchronous
If FALSE, the routine does not return until the specified event occurs. If TRUE, the routine returns immediately.
Return value
The ZwNotifyChangeKey routine returns STATUS_SUCCESS on success, or the appropriate NTSTATUS value otherwise. If the caller specifies TRUE for the Asynchronous parameter, and the event has not yet occurred, the routine returns STATUS_PENDING.
Remarks
If the call to the ZwNotifyChangeKey function occurs in user mode, you should use the name "NtNotifyChangeKey" instead of "ZwNotifyChangeKey".
For calls from kernel-mode drivers, the NtXxx and ZwXxx versions of a Windows Native System Services routine can behave differently in the way that they handle and interpret input parameters. For more information about the relationship between the NtXxx and ZwXxx versions of a routine, see Using Nt and Zw Versions of the Native System Services Routines.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 |
| Target Platform | Universal |
| Header | ntifs.h (include Ntifs.h) |
| Library | NtosKrnl.lib |
| DLL | NtosKrnl.exe |
| IRQL | PASSIVE_LEVEL |
| DDI compliance rules | HwStorPortProhibitedDDIs(storport), PowerIrpDDis(wdm) |