RtlGetNonVolatileToken function (ntddk.h)

Article
02/22/2024

The routine, RtlGetNonVolatileToken, gets various properties about a non-volatile memory buffer and stores them in the variable NvToken.

Syntax

NTSYSAPI NTSTATUS RtlGetNonVolatileToken(
  PVOID  NvBuffer,
  SIZE_T Size,
  PVOID  *NvToken
);

Parameters

NvBuffer

A pointer to the non-volatile memory that the returned NvToken is going to track state for. This should be an address obtained from a file mapping object.

Size

The length, in bytes, of the non-volatile memory buffer NvBuffer points to.

NvToken

A pointer to an opaque structure that tracks information about the given non-volatile memory region which RtlGetNonVolatileToken had returned.

Return value

The routine RtlGetNonVolatileToken returns one of the status codes:

Return code	Description
STATUS_ACCESS_DENIED	The caller had insufficient access rights to perform the requested action.
STATUS_INFO_LENGTH_MISMATCH	The specified base address is outside the range of accessible addresses.
STATUS_INVALID_PARAMETER	The NvBuffer is not the same length as specified inSize.
STATUS_SUCCESS	The request was successful.

Remarks

This routine is currently not supported for Windows Server until the next major release of Windows Server.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1703
Minimum supported server	None supported
Target Platform	Windows
Header	ntddk.h (include Winnt.h)