BuildTrusteeWithSidA function (aclapi.h)

The BuildTrusteeWithSid function initializes a TRUSTEE structure. The caller specifies the security identifier (SID) of the trustee. The function sets other members of the structure to default values and does not look up the name associated with the SID.

Syntax

void BuildTrusteeWithSidA(
  [in, out]      PTRUSTEE_A pTrustee,
  [in, optional] PSID       pSid
);

Parameters

[in, out] pTrustee

A pointer to a TRUSTEE structure to initialize. The BuildTrusteeWithSid function does not allocate any memory. If this parameter is NULL or a pointer that is not valid, the results are undefined.

[in, optional] pSid

A pointer to a SID structure that identifies the trustee. The BuildTrusteeWithSid function assigns this pointer to the ptstrName member of the TRUSTEE structure. The function sets the other members of the TRUSTEE structure as follows.

Value Meaning
pMultipleTrustee
NULL
MultipleTrusteeOperation
NO_MULTIPLE_TRUSTEE
TrusteeForm
TRUSTEE_IS_SID
TrusteeType
TRUSTEE_IS_UNKNOWN

Return value

None

Remarks

Note

The aclapi.h header defines BuildTrusteeWithSid as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header aclapi.h
Library Advapi32.lib
DLL Advapi32.dll

See also

Access Control Overview

Basic Access Control Functions

BuildTrusteeWithName

BuildTrusteeWithObjectsAndName

BuildTrusteeWithObjectsAndSid

TRUSTEE