ConvertSidToStringSidA 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 ConvertSidToStringSidA(
  PSID  Sid,
  LPSTR *StringSid
);

Parameters

Sid

A pointer to the SID structure to be converted.

StringSid

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.

Return code Description
ERROR_NOT_ENOUGH_MEMORY
Insufficient memory.
ERROR_INVALID_SID
The SID is not valid.
ERROR_INVALID_PARAMETER
One of the parameters contains a value that is not valid. This is most often a pointer that is not valid.

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

   
Minimum supported client Windows XP [desktop apps | UWP apps]
Minimum supported server Windows Server 2003 [desktop apps | UWP apps]
Target Platform Windows
Header sddl.h
Library Advapi32.lib
DLL Advapi32.dll

See Also

Access Control Overview

Basic Access Control Functions

ConvertSecurityDescriptorToStringSecurityDescriptor

ConvertStringSecurityDescriptorToSecurityDescriptor

ConvertStringSidToSid

SID