ConvertStringSecurityDescriptorToSecurityDescriptor function

The ConvertStringSecurityDescriptorToSecurityDescriptor function converts a string-format security descriptor into a valid, functional security descriptor. This function retrieves a security descriptor that the ConvertSecurityDescriptorToStringSecurityDescriptor function converted to string format.

Syntax

BOOL WINAPI ConvertStringSecurityDescriptorToSecurityDescriptor(
  _In_  LPCTSTR              StringSecurityDescriptor,
  _In_  DWORD                StringSDRevision,
  _Out_ PSECURITY_DESCRIPTOR *SecurityDescriptor,
  _Out_ PULONG               SecurityDescriptorSize
);

Parameters

StringSecurityDescriptor [in]

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

StringSDRevision [in]

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

SecurityDescriptor [out]

A pointer to a variable that receives a pointer to the converted security descriptor. The returned security descriptor is self-relative. To free the returned buffer, call the LocalFree function. To convert the security descriptor to an absolute security descriptor, use the MakeAbsoluteSD function.

SecurityDescriptorSize [out]

A pointer to a variable that receives the size, in bytes, of the converted security descriptor. This parameter can be NULL.

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. GetLastError may return one of the following error codes.

Remarks

If ace_type is ACCESS_ALLOWED_OBJECT_ACE_TYPE and neither object_guid nor inherit_object_guid has a GUID specified, then ConvertStringSecurityDescriptorToSecurityDescriptor converts ace_type to ACCESS_ALLOWED_ACE_TYPE. For information about the ace_type, object_guid, and inherit_object_guid fields, see Ace Strings.

Requirements

See also

Access Control Overview

Basic Access Control Functions

ConvertSecurityDescriptorToStringSecurityDescriptor

ConvertSidToStringSid

ConvertStringSidToSid

MakeAbsoluteSD

SECURITY_DESCRIPTOR