ZwReadOnlyEnlistment routine

The ZwReadOnlyEnlistment routine sets a specified enlistment to be read-only.

Syntax


NTSTATUS ZwReadOnlyEnlistment(
  _In_     HANDLE         EnlistmentHandle,
  _In_opt_ PLARGE_INTEGER TmVirtualClock
);

Parameters

EnlistmentHandle [in]

A handle to an enlistment object that was obtained by a previous call to ZwCreateEnlistment or ZwOpenEnlistment. The handle must have ENLISTMENT_SUBORDINATE_RIGHTS access to the object.

TmVirtualClock [in, optional]

A pointer to a virtual clock value. This parameter is optional and can be NULL.

Return value

ZwReadOnlyEnlistment returns STATUS_SUCCESS if the operation succeeds. Otherwise, this routine might return one of the following values:

Return codeDescription
STATUS_OBJECT_TYPE_MISMATCH

The specified handle is not a handle to an enlistment object.

STATUS_INVALID_HANDLE

The object handle is invalid.

STATUS_TRANSACTION_NOT_REQUESTED

The transaction or its enlistment is not in the correct state. For example, an enlistment cannot be read-only if the ENLISTMENT_SUPERIOR flag was specified to ZwCreateEnlistment.

STATUS_ACCESS_DENIED

The caller does not have appropriate access to the enlistment object.

 

The routine might return other NTSTATUS values.

Remarks

Your component cannot call ZwReadOnlyEnlistment for a superior enlistment.

For more information about ZwReadOnlyEnlistment, see Creating a Read-Only Enlistment.

NtReadOnlyEnlistment and ZwReadOnlyEnlistment are two versions of the same Windows Native System Services routine.

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

Target platform

Universal

Version

Available in Windows Vista and later operating system versions.

Header

Wdm.h (include Wdm.h, Ntddk.h, or Ntifs.h)

Library

NtosKrnl.lib

DLL

NtosKrnl.exe

IRQL

PASSIVE_LEVEL

DDI compliance rules

PowerIrpDDis, HwStorPortProhibitedDDIs

See also

Using Nt and Zw Versions of the Native System Services Routines
ZwCreateEnlistment
ZwOpenEnlistment

 

 

Send comments about this topic to Microsoft

Show: