CapyKit/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md
Jordan Wages 735d7c4c91 Documentation + Unfinished SecurityHelper
Committing the unfinished changes to the SecurityHelper as I flesh it out during the migration. Also starting a documentation folder powered by Sandcastle.
2024-04-19 23:12:24 -05:00

51 lines
994 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">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d
**C#**
``` C#
public void ReleaseItem(
PoolItem<T> item
)
```
**VB**
``` VB
Public Sub ReleaseItem (
item As PoolItem(Of T)
)
```
**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">PoolItem</a>(<a href="T_CapyKit_Pool_1">T</a>)</dt><dd>The item to release.</dd></dl>
## Remarks
This method sets the <a href="P_CapyKit_PoolItem_1_Locked">Locked</a> flag to false so that it can be retrieved by <a href="M_CapyKit_Pool_1_GetAvailableItem">GetAvailableItem()</a>.
## See Also
#### Reference
<a href="T_CapyKit_Pool_1">Pool(T) Class</a>
<a href="N_CapyKit">CapyKit Namespace</a>