3 Protocol Details
3.1 Server Details
3.1.4 Message Processing Events and Sequencing Rules
3.1.4.21 proc_CreateSite
@SiteId: The site collection identifier of the site collection which contains the document for which a co-authoring transition request was made.
@DocDirName: The directory name of the document.
@DocLeafName: The leaf name of the document.
@DocId: An output parameter containing the document identifier (2) of the document for which a co-authoring transition request was made.
@RequestGuid: The optional request identifier for the current request.
Return Code Values: MUST return an integer value of zero on successful completion. The stored procedure MUST return a nonzero value if an error occurs.
Result Sets: MUST NOT return any result sets.
3.1.4.21 proc_CreateSite
The proc_CreateSite stored procedure is called to create a new site collection with the specified metadata. The stored procedure is defined by using T-SQL syntax, as follows:
PROCEDURE proc_CreateSite(
@SiteId uniqueidentifier,
@SiteId: The site collection identifier of the site collection to be created.
@DirName: The directory name of the specified location. This parameter MUST be empty in the case of the host header site collection.
@LeafName: The leaf name of a site collection. This parameter MUST be empty in the case of the host header site collection.
@RootWebUrl: The virtual path relative to the top-level site. This parameter MUST be empty in the case of the host header site collection.
@Language: The LCID for the new site collection.
@Collation: The identifier that specifies the collation order.
@CalendarType: The identifier that specifies the calendar type that is being used.
@Time24: Specifies whether a 24-hour time format SHOULD be used when displaying time values.
If this parameter is set to 1, the 24-hour time format SHOULD be used; otherwise, the 12-hour time format SHOULD be used.
@OwnerSID: The SystemID of the owner of the site collection.
@OwnerLogin: The login name of the owner of the site collection.
@OwnerName: The display name of the owner of the site collection.
@OwnerEmail: The e-mail address of the owner of the site collection.
@SecondaryContactSID: The SystemID of the secondary contact of the site collection.
@SecondaryContactLogin: The login name of the secondary contact of the site collection. This parameter is ignored when @SecondaryContactSID is NULL or equal to @OwnerSID.
@SecondaryContactName: The display name of the secondary contact of the site collection. This parameter is ignored when @SecondaryContactSID is NULL or equal to @OwnerSID.
@SecondaryContactEmail: The e-mail address of the secondary contact of the site collection. This parameter is ignored when @SecondaryContactSID is NULL or equal to @OwnerSID.
@AdminsName: The display name of the site group for administrators.
@AdminsDescription: The description for the site group for administrators.
@AdminsPermMask: An access mask containing the rights that MUST be granted to the site group for administrators in the site collection.
@AuthorsName: The display name of the site group for site authors.
@AuthorsDescription: The description of the site group for site authors.
@AuthorsPermMask: An access mask containing the rights that MUST be granted to the site group for site authors.
@ContributorsName: The display name of the site group for site contributors.
@ContributorsDescription: The description of the site group for site contributors.
@ContributorsPermMask: An access mask containing the rights that MUST be granted to the site group for site contributors.
@BrowsersName: The display name of the site group for site browsers.
@BrowsersDescription: The description of the site group for site browsers.
@BrowsersPermMask: An access mask containing the list of rights that MUST be granted to the site group for site browsers.
@GuestsName: The display name of the site group for site guests.
@GuestsDescription: The description of the site group for site guests.
@GuestsPermMask: An access mask containing the rights that MUST be granted to the site group for site guests.
@SiteHashKey: The hash key of this site collection. It is a random set of 16 bytes which are used to generate the form digest validation for this site collection. This parameter can be NULL.
@HostHeader: The host header of this site collection. This parameter MUST be NULL when it is not a host header.
@UIVersion: A user interface (UI) version number that is associated with the newly created site collection. If this parameter is set to NULL, 3 will be used as the default value.
@RequestGuid: The optional request identifier for the current request.
Return values: An integer that MUST be listed in the following table.
Value Description
0 Successful execution.
80 The site collection identifier already exists in the database.
Result sets: MUST return up to seven result sets. Some of the result sets are returned
conditionally. Result sets from this stored procedure SHOULD be ignored by the caller. All result sets returned will be sent in the order specified in the following sections.
3.1.4.21.1 Site Owner Audit Mask Result Set
The Site Owner Audit Mask Result Set returns the information about the audit flags associated with the site (2) owner. The Site Owner Audit Mask Result Set MUST return a single row. It is defined in [MS-WSSEUX2] section 3.1.5.52.1.
3.1.4.21.2 Site Secondary Contact Audit Mask Result Set
The Site Secondary Contact Site Audit Mask Result Set returns the information about the Audit Flags associated with the site (2) secondary contact. This result set MUST NOT be returned if the
@SecondaryContactSID parameter is NULL. For information about the definition, refer to [MS-WSSEUX2], section 3.1.5.52.1.
3.1.4.21.3 Site Administrator Audit Mask Result Set
The Site Administrator Audit Mask Result Set returns the information about the Audit Flags associated with the site (2) administrator. For information about the definition, refer to [MS-WSSEUX2], section 3.1.5.52.1.
3.1.4.21.4 Site Author Audit Mask Result Set
The Site Author Audit Mask Result Set returns the information about the Audit Flags associated with the site (2) author. For information about the definition, refer [MS-WSSEUX2], section
3.1.5.52.1.
3.1.4.21.5 Site Contributor Audit Mask Result Set
The Site Contributor Audit Mask Result Set returns the information about the Audit Flags associated with the site (2) contributor. For information about the definition, refer to [MS-WSSEUX2], section 3.1.5.52.1.
3.1.4.21.6 Site Browser Audit Mask Result Set
The Site Browser Audit Mask Result Set returns the information about the Audit Flags associated with the site (2) browser. For information about the definition, refer to [MS-WSSEUX2], section 3.1.5.52.1.
3.1.4.21.7 Site Guest Audit Mask Result Set
The Site Guest Audit Mask Result Set returns the information about the Audit Flags associated with the site (2) guest. For information about the definition, refer to [MS-WSSEUX2], section 3.1.5.52.1.