ConvertSidToStringSid function

The ConvertSidToStringSid function converts a security identifier (SID) to a string format suitable for display, storage, or transmission.

To convert the string-format SID back to a valid, functional SID, call the ConvertStringSidToSid function.

Syntax

BOOL ConvertSidToStringSid(
  _In_  PSID   Sid,
  _Out_ LPTSTR *StringSid
);

Parameters

Sid [in]

A pointer to the SID structure to be converted.

StringSid [out]

A pointer to a variable that receives a pointer to a null-terminated SID string. To free the returned buffer, call the LocalFree function.

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. The GetLastError function may return one of the following error codes.

Remarks

The ConvertSidToStringSid function uses the standard S-R-I-S-S… format for SID strings. For more information about SID string notation, see SID Components.

Requirements

See also

Access Control Overview

Basic Access Control Functions

ConvertSecurityDescriptorToStringSecurityDescriptor

ConvertStringSecurityDescriptorToSecurityDescriptor

ConvertStringSidToSid

SID