CapyKit/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.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

38 lines
837 B
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# ReleaseItem Method
Releases the lock on the specified item and returns it to the pool.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**C#**
``` C#
public void ReleaseItem(
PoolItem<T> item
)
```
**F#**
``` F#
member ReleaseItem :
item : PoolItem<'T> -> unit
```
#### Parameters
<dl><dt>  <a href="T_CapyKit_PoolItem_1.md">PoolItem</a>(<a href="T_CapyKit_Pool_1.md">T</a>)</dt><dd>The item to release.</dd></dl>
## Remarks
This method sets the <a href="P_CapyKit_PoolItem_1_Locked.md">Locked</a> flag to false so that it can be retrieved by <a href="M_CapyKit_Pool_1_GetAvailableItem.md">GetAvailableItem()</a>.
## See Also
#### Reference
<a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>