FUNDAMENTACION DEL CALCULO

The proc_CheckoutDocumentInternal stored procedure is called to request or renew short-term check-out, or to request long-term check-out on a document. The T-SQL syntax for the stored procedure is as follows:

PROCEDURE proc_CheckoutDocumentInternal(

@SiteId uniqueidentifier, @WebId uniqueidentifier, @DirName nvarchar(256), @LeafName nvarchar(128), @Level tinyint, @EnableMinorVersions bit, @IsModerated bit, @UserId int, @CheckoutTimeout int,

@RefreshLock bit, @CheckoutToLocal bit, @IsForceCheckout bit, @IsSharedLock bit, @IsConvertLock bit, @Now datetime

@DocMetaInfo varbinary(max), @DocMetaInfoSize int,

@DocMetaInfoVersion int,

@RequestGuid uniqueidentifier = NULL OUTPUT );

@SiteId: The site collection identifier of the site collection which contains the document to be checked out.

@WebId: The site identifier of the site (2) which contains the document.

@DirName: The directory name of the document.

@LeafName: The leaf name of the document.

@Level: The publishing level of the document. For valid values, see [MS-WSSFO2] section 2.2.2.6.

@EnableMinorVersions: A bit flag specifying whether the document library containing the document has minor version numbering enabled. If minor version numbering is enabled for the document library containing the document, this parameter MUST be set to 1; otherwise this parameter MUST be set to zero. If the document is not in a document library, this parameter MUST be set to zero. This parameter MUST NOT be NULL.

@IsModerated: A bit flag specifying whether the document library containing the document has moderation enabled. If the document library containing the document is a moderated object, this parameter MUST be set to "1"; otherwise this parameter MUST be set to "0". If the document is not in a document library, this parameter MUST be set to "0". This parameter MUST NOT be NULL.

@UserId: The user identifier for the current user who is requesting a short-term check-out or a long-term check-out on the document. This value MUST refer to an existing user identifier for the specified site collection.

@CheckoutTimeout: The time-out in minutes for short-term check-out on the document. The

@CheckoutTimeout parameter MUST be NULL if a long-term check-out on the document is being specified.

@RefreshLock: A bit flag specifying whether the short-term check-out on the document needs to be refreshed. If this parameter is set to 1, the existing short-term check-out on the document MUST be refreshed for the number of minutes specified by the

@CheckoutTimeout parameter. This parameter MUST be set to zero to request a new short-term check-out or long-short-term check-out on the document. This parameter MUST NOT be NULL.

@CheckoutToLocal: A bit flag specifying whether the document is to be copied to local storage on the user's computer for editing. If this parameter is set to 1, the User computer SHOULD make a local copy of the document stream for editing and

proc_CheckoutDocumentInternal MUST NOT make a checked-out version of the document in the back-end database servers .

@IsForceCheckout: A bit flag specifying whether the document library containing the document requires that documents be checked out before any changes to the document can be made. If check-out is required for the document library containing the document, this parameter MUST be set to 1; otherwise this parameter MUST be set to zero. If the document is not in a

document library, this parameter MUST be set to zero. This parameter MUST NOT be NULL.

@IsSharedLock: A bit flag specifying whether the desired short-term lock on the document is a shared lock or an exclusive lock. This parameter MUST be set to 1 if the desired short-term lock is type shared; otherwise it MUST be set to zero.

@IsConvertLock: A bit flag specifying whether to convert an existing short-term lock from one short-term lock type to a different short-term lock type. This parameter MUST be set to 1 to convert the type of an existing short-term lock; otherwise it MUST be set to zero.

@Now: The current Coordinated Universal Time (UTC) time.

@DocMetaInfo: The metadata information for the document to be checked out. If there is no metadata information for this document, this parameter MUST be NULL.

@DocMetaInfoSize: Size in bytes of the document's metadata info. This MUST be NULL if

@DocMetaInfo is NULL.

@DocMetaInfoVersion: The version of the metadata information for the document to be checked out. This MUST be NULL if @DocMetaInfo is NULL.

@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.

3 File not found. A document corresponding to the specified @SiteId, @WebId,

@DirName, @LeafName, and @Level parameters was not found.

33 Short-term lock error. The document cannot have a short-term lock applied because another user has the document checked out.

154 Invalid minor version value. The minor version value for the document would exceed the maximum allowed value (511) if the document was checked out.

158 Check-out required. The document is in a document library with the Require Check Out option set, but the document is not checked out.

212 Site collection locked. The operation could not be performed because the site collection containing the document is in read-only mode.

1460 The lock has expired or the requested operation cannot be performed on the lock.

1630 Unsupported document type. The document specified is not valid for check-out; folders and sites (2) cannot be checked out.

1816 Disk quota error. The site collection disk quota has been reached.

6002 Short-term lock error. The document cannot have a short-term lock applied because another user has a shared short-term lock on the file.

6009 Short-term lock error. The document cannot have a short-term lock applied because

Value Description

another user has an exclusive short-term lock on the file.

Result sets: MUST NOT return any result sets.