SPFile.CheckInComment Property

Gets the comment that is used when a document is checked into a document library.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
<ClientCallableAttribute> _
<ClientCallableConstraintAttribute(Type := ClientCallableConstraintType.MaxLength, Value := )> _
Public ReadOnly Property CheckInComment As String
    Get
'Usage
Dim instance As SPFile
Dim value As String

value = instance.CheckInComment
[ClientCallableAttribute]
[ClientCallableConstraintAttribute(Type = ClientCallableConstraintType.MaxLength, Value = )]
public string CheckInComment { get; }

Property Value

Type: System.String
A string that contains the comment, or an empty string if there is no check-in comment.

Remarks

Although a check-in comment is not required in the user interface, the CheckIn method requires a comment as its parameter.

See Also

Reference

SPFile Class

SPFile Members

Microsoft.SharePoint Namespace