Creates a new instance of a
Lock pending action object
initialized with the specified parameters.
You typically do not need to explicitly create a Lock instance.
Calling lock-related methods creates an instance of Lock and adds it to the
underlying object's PendingActions collection. (See the Lock,
UpdateLock, FetchAndLockObject, and Unlock methods.)
Namespace:
FileNet.Api.Action
Assembly:
FileNet.Api (in FileNet.Api.dll)
Visual Basic (Declaration) |
---|
Public Sub New ( _
timeOut As Nullable(Of Long), _
owner As String _
) |
C# |
---|
public Lock(
Nullable<long> timeOut,
string owner
) |
Visual C++ |
---|
public:
Lock(
Nullable<long long> timeOut,
String^ owner
) |
JavaScript |
---|
FileNet.Api.Action.Lock = function(timeOut, owner); |
Parameters
- timeOut
- Type: System..::.Nullable<(Of <(Int64>)>)
The new value for the underlying object’s LockTimeout
property. The timeout value is the number of seconds that the object is intended
to be locked.
- owner
- Type: System..::.String
A String specifying the intended owner of the lock.
The value of this property is simply a custom string that has no real effect in
determining the user of the lock. The owner specified by this property is not
validated against any user or group known to the Content Engine. This value can
be any string, and is used to populate the underlying object’s LockOwner
property. It does not represent the actual user of the lock, which is recorded
internally by the server. If not supplied, defaults to the short principal name
of the requesting user.