[This is preliminary documentation and is subject to change.]

Sets a lock on a particular document by the currently logged in user.

Namespace:  OfficeClip.DBLayer.Desktop
Assembly:  OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0

Syntax

C#
public ReturnStatus SetLock(
	int userId,
	int documentId,
	DocHistoryStatus mode
)
Visual Basic (Declaration)
Public Function SetLock ( _
	userId As Integer, _
	documentId As Integer, _
	mode As DocHistoryStatus _
) As ReturnStatus
Visual C++
public:
ReturnStatus SetLock(
	int userId, 
	int documentId, 
	DocHistoryStatus mode
)

Parameters

userId
Type: System..::.Int32
The unique id of the user.
documentId
Type: System..::.Int32
Id of the document.
mode
Type: OfficeClip.Utils..::.DocHistoryStatus
The mode in which the lock has been put on the document. OfficeClip.Utils..::.DocHistoryStatus

Return Value

Enumerated value Utils.ReturnStatus indicating if the operation succeeded or failed. OfficeClip.Utils..::.ReturnStatus

See Also