RtlInitializeSid function (ntifs.h)

Article
02/22/2023

The RtlInitializeSid routine initializes a security identifier (SID) structure.

Syntax

NTSYSAPI NTSTATUS RtlInitializeSid(
  [out] PSID                      Sid,
  [in]  PSID_IDENTIFIER_AUTHORITY IdentifierAuthority,
  [in]  UCHAR                     SubAuthorityCount
);

Parameters

[out] Sid

Pointer to a caller-allocated SID structure to be initialized.

[in] IdentifierAuthority

Pointer to an SID_IDENTIFIER_AUTHORITY structure to set in the SID structure.

[in] SubAuthorityCount

Number of subauthorities to set in the SID. Subauthority values must be set separately, as described in the following Remarks section.

Return value

RtlInitializeSid returns one of the following:

Return code	Description
STATUS_SUCCESS	The SID was successfully initialized.
STATUS_INVALID_PARAMETER	The specified SubAuthorityCount value is invalid.

Remarks

Although RtlInitializeSid sets the number of subauthorities for the SID, it does not set the subauthority values. This must be done separately by calling RtlSubAuthoritySid.

For more information about security and access control, see Windows security model for driver developers and the documentation on these topics in the Windows SDK.

Requirements

Requirement	Value
Minimum supported client	Windows 2000
Target Platform	Universal
Header	ntifs.h (include Ntifs.h)
Library	NtosKrnl.lib
DLL	NtosKrnl.exe (kernel mode); Ntdll.dll (user mode)
IRQL	< DISPATCH_LEVEL

Share via