Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

RtlFormatCurrentUserKeyPath function

Applies to: desktop apps only

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

Syntax

Copy 
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

Minimum supported server

Windows 2000 Server

Header
Ntrtl.h

DLL
Ntdll.dll

See also

RtlFreeUnicodeString

 

 

Send comments about this topic to Microsoft

Build date: 4/6/2012

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Typographical error in the function prototype

There is a typographical error in the function prototype, it should be PUNICODE_STRING instead of UNICODE_STRING

NTSTATUS WINAPI RtlFormatCurrentUserKeyPath(
  __out  PUNICODE_STRING CurrentUserKeyPath
);
History