3.1.5.107 proc_SecSetSiteGroupProperties

The proc_SecSetSiteGroupProperties stored procedure is invoked to update properties of a site group.

 PROCEDURE proc_SecSetSiteGroupProperties(
       @SiteId                        uniqueidentifier,
       @GroupId                       int,
       @Title                         nvarchar(255),
       @Description                   nvarchar(512),
       @OwnerID                       int,
       @OwnerIsUser                   bit,
       @UserID                        int,
       @SiteAdmin                     bit,
       @GroupOwnerId                  int,
       @CurrentUserIsOwner            bit,
       @DLAlias                       nvarchar(255),
       @DLErrorMessage                nvarchar(255),
       @DLFlags                       int,
       @DLJobId                       int,
       @DLArchives                    varchar(4000),
       @RequestEmail                  nvarchar(255),
       @Flags                         int
 );

@SiteId: The Site Collection Identifier (section 2.2.1.9) of the site collection containing the site group to update.

@GroupId: The identifier for the site group to update.

@Title: The new user-friendly display name for the site group. If this parameter is NULL, the update MUST fail and the return code MUST be 80. However, if the user does not have sufficient permissions, the return code MUST be 5.

@Description: The new description for the site group. This parameter can be NULL.

@OwnerID: The identifier of a user, domain group, or site group to be set as the owner of the site group. This parameter MUST contain the identifier of an existing User, domain group, or site group.

@OwnerIsUser: A bit which specifies whether the value in @OwnerID is a User or domain group rather than a site group. A value of "1" specifies that the value in @OwnerID is a User or domain group. A value of "0" specifies that the value in @OwnerID is a site group.

@UserID: The User Identifier (section 2.2.1.13) of the current user. This parameter can be ignored by proc_SecSetSiteGroupProperties.

@SiteAdmin: A bit flag specifying whether the current user has site collection administration permissions. If this parameter is set to "1" to specify the current user has site collection administration permissions, site group management permissions MUST be granted. This parameter can be NULL.

@GroupOwnerId: The User Identifier or Site Group Identifier (section 2.2.1.10) to compare with the existing owner of the site group. Site group management permissions MUST be granted if the value in @GroupOwnerId matches the identifier of the existing owner of the site group and the value of @CurrentUserIsOwner is "1". This parameter can be NULL.

@CurrentUserIsOwner: A bit flag specifying whether the value in @GroupOwnerId is to be compared with the owner of the site group. Site group management permissions MUST be granted if the value in @GroupOwnerId matches the identifier of the existing owner of the site group and the value of @CurrentUserIsOwner is "1". This parameter can be NULL. If this parameter is NULL, the update MUST fail and the return code MUST be 80. However, if the user does not have sufficient permissions, the return code MUST be 5.

@DLAlias: The new email address for the distribution list associated with this site group. This parameter can be NULL.

@DLErrorMessage: The most recent error message returned by an asynchronous email distribution list operation, if any. This parameter can be NULL.

@DLFlags: An integer containing new status flags for the email distribution list associated with this group, as defined for the DLFlags column in the Sec_SiteGroupsView (section 2.2.7.6). This parameter can be NULL.

@DLJobId: Contains the job ID of a new currently pending asynchronous distribution list operation, or 0 if there is no pending operation. This parameter can be NULL.

@DLArchives: An array of bytes containing a new list of pairs of List Identifiers (section 2.2.1.5) defining additional Lists, which are the recipients of email sent to the email distribution list via the address in @DLAlias. Each GUID MUST be stored as a string, with commas separating the List's parent Site GUID and the List GUID, and with semicolons following each pair. This parameter can be NULL.

@RequestEmail: The new email address used to send a request to join or depart this site group. This parameter can be NULL.

@Flags: Contains the new membership permissions bit flags for the site group. The bit flags are defined in the description of the Flags column of the Sec_SiteGroupsView section.

Return Values: The proc_SecSetSiteGroupProperties stored procedure MUST return an integer return code from the following table:

Value

Description

0

Successful execution.

5

The current user does not have sufficient permissions to manage the site group, or the site collection is set to read-only.

80

An update error occurred or a parameter was invalid.

The proc_SecSetSiteGroupProperties stored procedure MUST NOT return a result set.