SPSite.LockIssue Property

Gets or sets the comment that is used in locking a site collection.

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

Syntax

'Declaration
Public Property LockIssue As String
    Get
    Set
'Usage
Dim instance As SPSite
Dim value As String

value = instance.LockIssue

instance.LockIssue = value
public string LockIssue { get; set; }

Property Value

Type: System.String
A string that contains the comment.

Examples

The following code example uses the LockIssue property to explain why a specified site collection is being write-locked.

Using oSiteCollection As New SPSite("http://Site_Name")
    oSiteCollection.WriteLocked = True
    oSiteCollection.ReadLocked = False
    oSiteCollection.LockIssue = "Customer did not pay bill."
End Using
using (SPSite oSiteCollection = new SPSite("http://Site_Name"))
{
    oSiteCollection.WriteLocked = true;
    oSiteCollection.ReadLocked  = false;
    oSiteCollection.LockIssue   = "Customer did not pay bill.";
}

Note

Certain objects implement the IDisposable interface, and you must avoid retaining these objects in memory after they are no longer needed. For information about good coding practices, see Disposing Objects.

See Also

Reference

SPSite Class

SPSite Members

Microsoft.SharePoint Namespace