RtlFormatCurrentUserKeyPath function

Initializes the supplied buffer with a string representation of the SID for the current user.

Syntax

NTSTATUS WINAPI RtlFormatCurrentUserKeyPath(
  _Out_ UNICODE_STRING CurrentUserKeyPath
);

Parameters

  • CurrentUserKeyPath [out]
    String that represents the current user's root key in the Registry. Caller must call RtlFreeUnicodeString to free the buffer when done with it.

Return value

Returns STATUS_SUCCESS if the user string was successfully initialized.

Additional NTSTATUS values are defined in NTSTATUS.H, which is distributed with the Windows DDK.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Ntrtl.h

DLL

Ntdll.dll

See also

RtlFreeUnicodeString