IHierarchyItem.SetCommentAndAuthor Method (String, String)

IT Hit WebDAV for .NET

Updates comment and author information.

[Visual Basic]
Sub SetCommentAndAuthor( _
   ByVal comment As String, _
   ByVal author As String _
)
[C#]
void SetCommentAndAuthor(
   string comment,
   string author
);

Parameters

comment
Comment about an item that is suitable for presentation to a user.
author
Description of the creator of the item.

Exceptions

Exception Type Condition
UnauthorizedException Request 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.
LockedException This item is locked and no lock token was specified.
ConflictException The item is version controlled and has to be checked out to be edited.
NotFoundException This item doesn't exist on the server.
WebDavHttpException Server returned unknown error.
WebDavException In case of any unexpected error.

Example

The following example demonstrates how to lock item, check-out, update, check-in, unlock and set comment and author for a version. 

                
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

IHierarchyItem Interface | ITHit.WebDAV.Client Namespace | IHierarchyItem.SetCommentAndAuthor Overload List