Click or drag to resize

IHierarchyItemSetCommentAndAuthor Method (String, String)

IT Hit WebDAV Classes Reference
Updates comment and author information.

Namespace:  ITHit.WebDAV.Client
Assembly:  ITHit.WebDAV.Client (in ITHit.WebDAV.Client.dll) Version: 2.0.420.0
Syntax
Copy
void SetCommentAndAuthor(
	string comment,
	string author
)

Parameters

comment
Type: SystemString
Comment about an item that is suitable for presentation to a user.
author
Type: SystemString
Description of the creator of the item.
Exceptions
ExceptionCondition
UnauthorizedExceptionRequest is not authorized.
LockedException The specified resource or folder is locked and the client either is not a lock owner or the lock type requires a lock token to be submitted and the client did not submit it.
LockedExceptionThis item is locked and no lock token was specified.
ConflictExceptionThe item is version controlled and has to be checked out to be edited.
NotFoundExceptionThis item doesn't exist on the server.
WebDavHttpExceptionServer returned unknown error.
WebDavExceptionIn case of any unexpected error.
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...
WebDavSession session = new WebDavSession(license);
session.Credentials = new NetworkCredential("User1", "pwd");

IResource resource = session.OpenResource(new Uri("http://server/directory/resource.docx"));
LockInfo lockInfo = resource.Lock(LockScope.Exclusive, false, "John Walter", TimeSpan.MaxValue);
resource.CheckOut(lockInfo.LockToken.LockToken);
resource.UpdateProperties(
    new Property[] {new Property(new PropertyName("amount", "server"), "2")}, null,
    lockInfo.LockToken.LockToken);
IVersion version = resource.CheckIn(lockInfo.LockToken.LockToken);
resource.Unlock(lockInfo.LockToken.LockToken);
version.SetCommentAndAuthor("Fixed some bugs.", "John");
See Also