ConvertStringSidToSidA function

The ConvertStringSidToSid function converts a string-format security identifier (SID) into a valid, functional SID. You can use this function to retrieve a SID that the ConvertSidToStringSid function converted to string format.

Syntax

BOOL ConvertStringSidToSidA(
  LPCSTR StringSid,
  PSID   *Sid
);

Parameters

StringSid

A pointer to a null-terminated string containing the string-format SID to convert.

The SID string can use either the standard S-R-I-S-S… format for SID strings, or the SID string constant format, such as "BA" for built-in administrators. For more information about SID string notation, see SID Components.

Sid

A pointer to a variable that receives a pointer to the converted SID. 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_INVALID_PARAMETER
Invalid parameter.
ERROR_INVALID_SID
Invalid SID.

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

Basic Access Control Functions

ConvertSecurityDescriptorToStringSecurityDescriptor

ConvertSidToStringSid

ConvertStringSecurityDescriptorToSecurityDescriptor

SID