Click or drag to resize

IFileUnCheckOutAsync Method

IT Hit WebDAV Classes Reference
Cancels the CHECKOUT and restore the pre-CHECKOUT state of the version-controlled resource.

Namespace:  ITHit.WebDAV.Client
Assembly:  ITHit.WebDAV.Client (in ITHit.WebDAV.Client.dll) Version: 6.0.4052-Beta
Syntax
Task UnCheckOutAsync(
	string lockToken = null,
	IDictionary<string, string> headers = null,
	CancellationToken cancellationToken = null
)

Parameters

lockToken (Optional)
Type: SystemString
Lock token for this item.
headers (Optional)
Type: System.Collections.GenericIDictionaryString, String
Request headers.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
Propagates notification that operations should be canceled.

Return Value

Type: Task

[Missing <returns> documentation for "M:ITHit.WebDAV.Client.IFile.UnCheckOutAsync(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Threading.CancellationToken)"]

Exceptions
ExceptionCondition
InvalidCheckOutCheckInStateException The resource must be under version control in checked out state.
LockedExceptionThis item is locked and invalid lock token was provided.
UnauthorizedExceptionRequest is not authorized.
NotFoundExceptionThis resource doesn't exist on the server.
WebDavHttpExceptionServer returned unknown error.
WebDavExceptionIn case of any unexpected error.
Examples
The following example demonstrates how to restore pre-checked-out state of the item.
string license = "<?xml version='1.0' encoding='utf...
WebDavSessionAsync session = new WebDavSessionAsync(license);
session.Credentials = new NetworkCredential("User1", "pwd");

IFile file = await session.GetFileAsync(new Uri("https://server/directory/file.docx"));
LockInfo lockInfo = await file.LockAsync(LockScope.Exclusive, false, "John Walter", TimeSpan.MaxValue);
await file.CheckOutAsync(lockInfo.LockToken.LockToken);
//Modify file content or properties here.
//....
await file.UnCheckOutAsync(lockInfo.LockToken.LockToken);
await file.UnlockAsync(lockInfo.LockToken.LockToken);
See Also