Skip to content

Latest commit

 

History

History
127 lines (90 loc) · 4.67 KB

nf-ntifs-rtlsetgroupsecuritydescriptor.md

File metadata and controls

127 lines (90 loc) · 4.67 KB
Raw
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:ntifs.RtlSetGroupSecurityDescriptor
RtlSetGroupSecurityDescriptor function (ntifs.h)
The RtlSetGroupSecurityDescriptor routine sets the primary group information of an absolute-format security descriptor. It replaces any primary group information that is already present in the security descriptor.
ifsk\rtlsetgroupsecuritydescriptor.htm
ifsk
04/16/2018
RtlSetGroupSecurityDescriptor function
RtlSetGroupSecurityDescriptor, RtlSetGroupSecurityDescriptor routine [Installable File System Drivers], ifsk.rtlsetgroupsecuritydescriptor, ntifs/RtlSetGroupSecurityDescriptor, rtlref_113e5ca7-5db3-4c93-a26f-c568e2164de9.xml
ntifs.h
Ntifs.h
Universal
Windows Server 2003 SP1
NtosKrnl.lib
NtosKrnl.exe (kernel mode); Ntdll.dll (user mode)
<= APC_LEVEL
Windows
RtlSetGroupSecurityDescriptor
ntifs/RtlSetGroupSecurityDescriptor
APIRef
kbSyntax
DllExport
NtosKrnl.exe
Ntdll.dll
RtlSetGroupSecurityDescriptor

RtlSetGroupSecurityDescriptor function

-description

The RtlSetGroupSecurityDescriptor routine sets the primary group information of an absolute-format security descriptor. It replaces any primary group information that is already present in the security descriptor.

-parameters

-param SecurityDescriptor [in, out]

Pointer to the SECURITY_DESCRIPTOR structure whose primary group is to be set. RtlSetGroupSecurityDescriptor replaces any existing primary group with the new primary group.

-param Group [in, optional]

Pointer to a security identifier (SID) structure for the security descriptor's new primary owner. This pointer, not the SID structure itself, is copied into the security descriptor. If Group is NULL, RtlSetGroupSecurityDescriptor clears the security descriptor's primary group information. This marks the security descriptor as having no primary group.

-param GroupDefaulted [in, optional]

Set this Boolean variable to TRUE if the primary group information is derived from a default mechanism. If this parameter is TRUE, RtlSetGroupSecurityDescriptor sets the SE_GROUP_DEFAULTED flag in the security descriptor's SECURITY_DESCRIPTOR_CONTROL field. If this parameter is FALSE, RtlSetGroupSecurityDescriptor clears the SE_GROUP_DEFAULTED flag.

-returns

RtlSetGroupSecurityDescriptor returns STATUS_SUCCESS if the primary group was successfully set or reset. Otherwise, it returns an appropriate NTSTATUS value such as one of the following:

Return code Description
STATUS_INVALID_SECURITY_DESCR
 The given security descriptor is not a valid absolute security descriptor. STATUS_INVALID_SECURITY_DESCR is an error code.
STATUS_UNKNOWN_REVISION
 The given security descriptor's revision is not recognized by this routine. STATUS_UNKNOWN_REVISION is an error code.

-remarks

To retrieve the primary group information for a security descriptor, use RtlGetGroupSecurityDescriptor.

To set the owner information for a security descriptor, use RtlSetOwnerSecurityDescriptor.

For more information about security and access control, see the Microsoft Windows SDK documentation.

-see-also

RtlGetGroupSecurityDescriptor

RtlSetOwnerSecurityDescriptor

SECURITY_DESCRIPTOR

SECURITY_DESCRIPTOR_CONTROL

SID