The ConvertSecurityDescriptorToStringSecurityDescriptor function converts a security descriptor to a string format. You can use the string format to store or transmit the security descriptor.

To convert the string-format security descriptor back to a valid, functional security descriptor, call the ConvertStringSecurityDescriptorToSecurityDescriptor function.

Syntax

BOOL WINAPI ConvertSecurityDescriptorToStringSecurityDescriptor(
  __in   PSECURITY_DESCRIPTOR SecurityDescriptor,
  __in   DWORD RequestedStringSDRevision,
  __in   SECURITY_INFORMATION SecurityInformation,
  __out  LPTSTR *StringSecurityDescriptor,
  __out  PULONG StringSecurityDescriptorLen
);

Parameters

SecurityDescriptor [in]

A pointer to the security descriptor to convert. The security descriptor can be in absolute or self-relative format.

RequestedStringSDRevision [in]

Specifies the revision level of the output StringSecurityDescriptor string. Currently this value must be SDDL_REVISION_1.

SecurityInformation [in]

Specifies a combination of the following SECURITY_INFORMATION bit flags to indicate the components of the security descriptor to include in the output string.

Value	Meaning
OWNER_SECURITY_INFORMATION 0x00000001L	Include the owner.
GROUP_SECURITY_INFORMATION 0x00000002L	Include the primary group.
DACL_SECURITY_INFORMATION 0x00000004L	Include the discretionary access control list (DACL).
SACL_SECURITY_INFORMATION 0x00000008L	Include the system access control list (SACL).
LABEL_SECURITY_INFORMATION 0x00000010L	Include the mandatory integrity label access control entry (ACE).

 

StringSecurityDescriptor [out]

A pointer to a variable that receives a pointer to a null-terminated security descriptor string. For a description of the string format, see Security Descriptor String Format. To free the returned buffer, call the LocalFree function.

StringSecurityDescriptorLen [out]

A pointer to a variable that receives the size, in TCHARs, of the security descriptor string returned in the StringSecurityDescriptor buffer. This parameter can be NULL if you do not need to retrieve the size.

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

If the DACL is NULL, and the SE_DACL_PRESENT control bit is set in the input security descriptor, the function fails.

If the DACL is NULL, and the SE_DACL_PRESENT control bit is not set in the input security descriptor, the resulting security descriptor string does not have a D: component. For more information, see Security Descriptor String Format.

Requirements

See Also

Access Control Overview

Basic Access Control Functions

ConvertSidToStringSid

ConvertStringSecurityDescriptorToSecurityDescriptor

ConvertStringSidToSid

SECURITY_DESCRIPTOR

Send comments about this topic to Microsoft

Build date: 9/11/2009