ConvertStringSidToSid function
Applies to: desktop apps only
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 WINAPI ConvertStringSidToSid( __in LPCTSTR StringSid, __out PSID *Sid );
Parameters
- StringSid [in]
-
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 [out]
-
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 |
|---|---|
|
Invalid parameter. |
|
Invalid SID. |
Requirements
|
Minimum supported client | Windows XP |
|---|---|
|
Minimum supported server | Windows Server 2003 |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names | ConvertStringSidToSidW (Unicode) and ConvertStringSidToSidA (ANSI) |
See also
- Access Control
- Basic Access Control Functions
- ConvertSecurityDescriptorToStringSecurityDescriptor
- ConvertSidToStringSid
- ConvertStringSecurityDescriptorToSecurityDescriptor
- SID
Send comments about this topic to Microsoft
Build date: 3/7/2012
