SPFileVersion.CheckInComment Property
Gets the latest check-in comment for the file before it became a version.
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online
Syntax
'Declaration
<ClientCallableConstraintAttribute(Type := ClientCallableConstraintType.NotNull)> _
<ClientCallableAttribute> _
<ClientCallableConstraintAttribute(Type := ClientCallableConstraintType.MaxLength, Value := "1023")> _
Public ReadOnly Property CheckInComment As String
Get
'Usage
Dim instance As SPFileVersion
Dim value As String
value = instance.CheckInComment
[ClientCallableConstraintAttribute(Type = ClientCallableConstraintType.NotNull)]
[ClientCallableAttribute]
[ClientCallableConstraintAttribute(Type = ClientCallableConstraintType.MaxLength, Value = "1023")]
public string CheckInComment { get; }
Property Value
Type: System.String
A string that contains the comment.
Remarks
When a file becomes a version, its properties are maintained with the version. This includes the check-in comment and other information for the file.
Although a check-in comment is not required in the user interface, the CheckIn method requires a comment as its parameter.