CheckOut Method

Checks out a document.

Syntax

sharepoint.checkOut(remoteFile, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Checking out a document prevents others from altering the document until you CheckIn your changes.

CheckOut does not retrieve data. The Get method can be used to retrieve the document contents.