3.1.5.3.15 uncheckout document

  • Article

The uncheckout document request is used by the client to reverse a long-term checkout of a file from source control. If the file has changed since it was checked out, those changes are reverted. This request is also used to release a short-term checkout, in which case changes are not reverted. Because clients conforming to the FrontPage Server Extensions Remote Protocol MUST NOT assume the server supports long-term checkouts, only the latter use is pertinent.

Tokens

service_name: This parameter is deprecated. See service_name in section 3.1.5.3.1.

document_name: A URL-STRING specifying the service-relative path of the current document.

force: A BOOLEAN value that specifies whether the server reverses the checkout of a file by another user. Clients conforming to the FrontPage Server Extensions Remote Protocol MUST NOT send this parameter as TRUE. The server MAY ignore this value. If the server implements this functionality, it SHOULD do client authorization checks for permissions to perform this action and ignore the parameter if those checks fail.

time_checked_out: A TIME indicating the client's record of the time and date at which the file was last checked out. The server MAY refuse to revert a checkout if the time does not match the server's record of the time the file was checked out.

rlsshortterm: A BOOLEAN value indicates if the client wants to release a short-term checkout or a long-term checkout. If TRUE, the server MUST release the lock; otherwise, the server SHOULD release any long-term checkout the client has acquired. Clients conforming to the FrontPage Server Extensions Remote Protocol MUST NOT assume the server supports long-term checkout and thus MUST send TRUE for this parameter. The server can return an appropriate error if the client does not have the kind of checkout it is trying to undo.

validateWelcomeNames: For semantics, see section 3.1.5.3.1.

URL

FPAuthorScriptUrl

Return Values

The server can return the error code 0x0009000F 2.2.2.2.17.1.

meta_info: The METADICT (section 2.2.2.2.11) information about the document that has been unchecked out.