ConvertSidToStringSidA function (sddl.h)
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(
[in] PSID Sid,
[out] LPSTR *StringSid
);
Parameters
[in] Sid
A pointer to the SID structure to be converted.
[out] 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 |
|---|---|
|
Insufficient memory. |
|
The SID is not valid. |
|
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.
Note
The sddl.h header defines ConvertSidToStringSid 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 | 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
Basic Access Control Functions
ConvertSecurityDescriptorToStringSecurityDescriptor