CapyKit/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md
Jordan Wages 87bd044b31 Settings Helper + Documentation
The `SettingsHelper` is an agnostic way to access settings values uniformly through code. The accessor methods are controlled by the consumer.

Documentation has been a bit wonky. I changed the max number of version number components allowed, so each new build should not create new changes on every single bit of documentation now.
2024-04-22 18:28:21 -05:00

694 B

SetLock Method

Sets the lock on the item indicating that it is in use.

Definition

Namespace: CapyKit
Assembly: CapyKit (in CapyKit.dll) Version: 1.0.0

C#

public bool SetLock()

F#

member SetLock : unit -> bool 

Return Value

Boolean
true if the item is locked successfully, false if it fails.

Remarks

If the item is already locked, an error event is emitted.

See Also

Reference

PoolItem(T) Class
CapyKit Namespace