Click or drag to resize

IFileAsyncCheckOutAsync Method

IT Hit WebDAV Classes Reference
Allow modifications to the content and custom properties of this version-controlled resource.

Namespace:  ITHit.WebDAV.Client
Assembly:  ITHit.WebDAV.Client (in ITHit.WebDAV.Client.dll) Version: 2.0.420.0
Syntax
Copy
Task CheckOutAsync()

Return Value

Type: Task

[Missing <returns> documentation for "M:ITHit.WebDAV.Client.IFileAsync.CheckOutAsync"]

Exceptions
ExceptionCondition
InvalidCheckOutCheckInStateException The resource must be versionable and in checked in state.
UnsupportedDeltaVResult Server returned result that is not supported by this client( DAV:checkout-of-version-with-descendant-is-forbidden DAV:checkout-of-version-with-descendant-is-discouraged DAV:checkout-of-checked-out-version-is-forbidden DAV:checkout-of-checked-out-version-is-discouraged)
LockedExceptionThe resource is locked and no 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.
Remarks
To allow modifications on a version-controlled item it must be first checked-out. If you would like to protect item from being modified by other users you will also lock the item.
Examples
The following example demonstrates how to lock item, check-out, update, check-in, unlock and set comment and author for a version.
Copy
string license = "<?xml version='1.0' encoding='utf...
WebDavSessionAsync session = new WebDavSessionAsync(license);
session.Credentials = new NetworkCredential("User1", "pwd");

IFileAsync file = await session.OpenFileAsync(new Uri("http://server/directory/file.docx"));
LockInfo lockInfo = await file.LockAsync(LockScope.Exclusive, false, "John Walter", TimeSpan.MaxValue);
await file.CheckOutAsync(lockInfo.LockToken.LockToken);
await file.UpdatePropertiesAsync(
    new Property[] {new Property(new PropertyName("amount", "server"), "2")}, null,
    lockInfo.LockToken.LockToken);
IVersionAsync version = await file.CheckInAsync(lockInfo.LockToken.LockToken);
await file.UnlockAsync(lockInfo.LockToken.LockToken);
await version.SetCommentAndAuthorAsync("Fixed some bugs.", "John");
See Also