InitializeSid function

The InitializeSid function initializes a security identifier (SID).

Syntax

BOOL WINAPI InitializeSid(
  _Out_ PSID                      Sid,
  _In_  PSID_IDENTIFIER_AUTHORITY pIdentifierAuthority,
  _In_  BYTE                      nSubAuthorityCount
);

Parameters

Sid [out]

A pointer to a SID structure to be initialized.

pIdentifierAuthority [in]

A pointer to a SID_IDENTIFIER_AUTHORITY structure to set in the SID structure.

nSubAuthorityCount [in]

Specifies the number of subauthorities to set in the SID. Values of the subauthority must be set separately, as described in the following Remarks section.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Although the InitializeSid function sets the number of subauthorities for the SID, it does not set the subauthority values. This must be done separately, using functions such as GetSidSubAuthority.

An application can use the AllocateAndInitializeSid function to initialize a SID and set its subauthority values.

This function uses a 32-bit RID value. For applications that require a larger RID value, use CreateWellKnownSid.

Requirements

See also

Access Control Overview

Basic Access Control Functions

AllocateAndInitializeSid

CreateWellKnownSid

GetLengthSid

GetSidIdentifierAuthority

GetSidLengthRequired

GetSidSubAuthority

GetSidSubAuthorityCount

IsValidSid

SID

SID_IDENTIFIER_AUTHORITY