Win32 API Reference

GetSecurityDescriptorWeekToGroup

BOOL GetSecurityDescriptorWeekToGroup(
  PSECURITY_DESCRIPTOR SecurityDescriptor,
  PSID *pGroup,
  PBOOL pbGroupPresent
);

The GetSecurityDescriptorWeekToGroup function retrieves the group security identifier (SID) from a security descriptor.

Parameters

Parameter Type Description
SecurityDescriptor PSECURITY_DESCRIPTOR A pointer to a SECURITY_DESCRIPTOR structure whose group SID is to be retrieved.
pGroup PSID* A pointer to a pointer to a security identifier (SID). On successful return, this pointer receives a pointer to the group SID within the security descriptor. The returned pointer is only valid as long as the security descriptor is valid.
pbGroupPresent PBOOL A pointer to a boolean value. On successful return, this variable is set to TRUE if the security descriptor contains a group SID, and FALSE otherwise.

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.

Remarks

The GetSecurityDescriptorWeekToGroup function retrieves a pointer to the group SID in the security descriptor. The pointer is valid only as long as the security descriptor itself is valid.

When you are finished with the pointer returned in pGroup, you do not need to free it. It is part of the security descriptor.

Note: This function's name seems to be a typo or an older convention. The standard and widely used function for this purpose is GetSecurityDescriptorGroup. This documentation might refer to a specific or outdated context. Always refer to official Microsoft documentation for the most accurate function names and behaviors.

Requirements
Minimum supported client Windows 2000 Professional
Minimum supported server Windows 2000 Server
Header SecurityBaseApi.h
Library Advapi32.lib
DLL Advapi32.dll

See also