wagesj45/CapyKit
wagesj45/CapyKit
1
0
Fork 0
mirror of https://github.com/wagesj45/CapyKit.git synced 2025-02-05 10:52:58 -06:00
Code Issues Projects Releases Packages 1 Wiki Activity

Documenation Link Fix

Browse source
This commit is contained in:
Jordan Wages 2024-04-21 03:30:36 -05:00
parent cbdeded5be
commit 97072cdb20
178 changed files with 2099 additions and 784 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Documentation/ContentLayout.content
View file

@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<Topics> <Topics>
<Topic id="849aa079-3d64-4cf1-966f-44af23c73160" visible="True" isDefault="true" isSelected="true" title="Welcome to the [TODO: Add project name]"> <Topic id="849aa079-3d64-4cf1-966f-44af23c73160" visible="True" isDefault="true" isSelected="true" title="CapyKit - C# Utilities">
<HelpKeywords> <HelpKeywords>
<HelpKeyword index="K" term="Welcome" /> <HelpKeyword index="K" term="Welcome" />
</HelpKeywords> </HelpKeywords>
</Topic> </Topic>
<Topic id="7d36447b-0aab-4ce9-b5ed-e60ec5bee103" visible="True" isExpanded="true" title="Version History"> <Topic id="7d36447b-0aab-4ce9-b5ed-e60ec5bee103" visible="True" title="Version History">
<HelpKeywords> <HelpKeywords>
<HelpKeyword index="K" term="version, history" /> <HelpKeyword index="K" term="version, history" />
</HelpKeywords> </HelpKeywords>

26
Documentation/Documentation.shfbproj
View file

@ -18,17 +18,18 @@
<Name>Documentation</Name> <Name>Documentation</Name>
<!-- SHFB properties --> <!-- SHFB properties -->
<FrameworkVersion>.NET Framework 4.7.2</FrameworkVersion> <FrameworkVersion>.NET Framework 4.7.2</FrameworkVersion>
<OutputPath>.\Help\</OutputPath> <OutputPath>Help\</OutputPath>
<HtmlHelpName>Documentation</HtmlHelpName> <HtmlHelpName>Documentation</HtmlHelpName>
<Language>en-US</Language> <Language>en-US</Language>
<TransformComponentArguments> <TransformComponentArguments>
<Argument Key="logoFile" Value="Help.png" xmlns="" /> <Argument Key="BibliographyDataFile" Value="True" />
<Argument Key="logoHeight" Value="" xmlns="" /> <Argument Key="MaxVersionParts" Value="" />
<Argument Key="logoWidth" Value="" xmlns="" /> <Argument Key="IncludeEnumValues" Value="True" />
<Argument Key="logoAltText" Value="" xmlns="" /> <Argument Key="EnumMemberSortOrder" Value="Value" />
<Argument Key="logoPlacement" Value="left" xmlns="" /> <Argument Key="FlagsEnumValueFormat" Value="IntegerValue" />
<Argument Key="logoAlignment" Value="left" xmlns="" /> <Argument Key="FlagsEnumSeparatorSize" Value="0" />
<Argument Key="maxVersionParts" Value="" xmlns="" /> <Argument Key="BaseSourceCodeUrl" Value="" />
<Argument Key="ShowParametersOnAllMethods" Value="False" />
</TransformComponentArguments> </TransformComponentArguments>
<HelpFileFormat>Markdown</HelpFileFormat> <HelpFileFormat>Markdown</HelpFileFormat>
<SyntaxFilters>C#, F#</SyntaxFilters> <SyntaxFilters>C#, F#</SyntaxFilters>
@ -51,6 +52,15 @@
<MaximumGroupParts>2</MaximumGroupParts> <MaximumGroupParts>2</MaximumGroupParts>
<Preliminary>False</Preliminary> <Preliminary>False</Preliminary>
<SdkLinkTarget>Blank</SdkLinkTarget> <SdkLinkTarget>Blank</SdkLinkTarget>
<VisibleItems>Attributes, ExplicitInterfaceImplementations, InheritedMembers, InheritedFrameworkMembers, Internals, Privates, PrivateFields, Protected, SealedProtected, ProtectedInternalAsProtected, NonBrowsable</VisibleItems>
<PlugInConfigurations />
<ComponentConfigurations />
<WarnOnMissingSourceContext>False</WarnOnMissingSourceContext>
<HtmlSdkLinkType>Msdn</HtmlSdkLinkType>
<BinaryTOC>True</BinaryTOC>
<IncludeFavorites>False</IncludeFavorites>
<WebsiteSdkLinkType>Msdn</WebsiteSdkLinkType>
<AppendMarkdownFileExtensionsToUrls>True</AppendMarkdownFileExtensionsToUrls>
</PropertyGroup> </PropertyGroup>
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform <!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
the build. The others are optional common platform types that may appear. --> the build. The others are optional common platform types that may appear. -->

4
Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md
View file

@ -6,7 +6,7 @@ The topics in this section describe the various changes made to the [TODO: Proje
## Version History ## Version History
Select a version below to see a description of its changes. Select a version below to see a description of its changes.
<ul><li><p><a href="fa7407d1-9116-4ad7-a9ab-ed094685b070">Version 1.0.0.0</a></p></li><li><p>[TODO: Add links to each specific version page]</p></li></ul> <ul><li><p><a href="fa7407d1-9116-4ad7-a9ab-ed094685b070.md">Version 1.0.0.0</a></p></li><li><p>[TODO: Add links to each specific version page]</p></li></ul>
@ -14,4 +14,4 @@ Select a version below to see a description of its changes.
#### Other Resources #### Other Resources
<a href="849aa079-3d64-4cf1-966f-44af23c73160">Welcome to the [TODO: Add project name]</a> <a href="849aa079-3d64-4cf1-966f-44af23c73160.md">CapyKit - C# Utilities</a>

4
Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md
View file

@ -1,4 +1,4 @@
# Welcome to the [TODO: Add project name] # CapyKit - C# Utilities
This is a sample conceptual topic. You can use this as a starting point for adding more conceptual content to your help project. This is a sample conceptual topic. You can use this as a starting point for adding more conceptual content to your help project.
@ -24,4 +24,4 @@ See the **Conceptual Content** topics in the Sandcastle Help File Builder's help
#### Other Resources #### Other Resources
<a href="7d36447b-0aab-4ce9-b5ed-e60ec5bee103">Version History</a> <a href="7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md">Version History</a>

32
Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md Normal file
View file

@ -0,0 +1,32 @@
# uniqueIdentifiers Field
A hash set storing unique identifiers for events intended to only be emitted once.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private static HashSet<string> uniqueIdentifiers
```
**F#**
``` F#
static val mutable private uniqueIdentifiers: HashSet<string>
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.hashset-1" target="_blank" rel="noopener noreferrer">HashSet</a>(<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>)
## See Also
#### Reference
<a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>
<a href="M_CapyKit_CapyEventReporter_EmitEventOnce.md">EmitEventOnce(EventLevel, String, String, String, Object[])</a>

31
Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md Normal file
View file

@ -0,0 +1,31 @@
# LOWER_CASE_CHARACTERS Field
A string of all the lower case characters.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
internal const string LOWER_CASE_CHARACTERS = "abcdefghijklmnopqrstuvwxyz"
```
**F#**
``` F#
static val mutable internal LOWER_CASE_CHARACTERS: string
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

31
Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md Normal file
View file

@ -0,0 +1,31 @@
# NUMBER_CHARACTERS Field
A string of all the numeric characters.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
internal const string NUMBER_CHARACTERS = "0123456789"
```
**F#**
``` F#
static val mutable internal NUMBER_CHARACTERS: string
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

31
Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md Normal file
View file

@ -0,0 +1,31 @@
# SPECIAL_CHARACTERS Field
A string of the most common non-alphanumeric characters.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
internal const string SPECIAL_CHARACTERS = "!@#$%&?+-_"
```
**F#**
``` F#
static val mutable internal SPECIAL_CHARACTERS: string
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

31
Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md Normal file
View file

@ -0,0 +1,31 @@
# UPPER_CASE_CHARACTERS Field
A string of all the upper case characters.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
internal const string UPPER_CASE_CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
```
**F#**
``` F#
static val mutable internal UPPER_CASE_CHARACTERS: string
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

31
Documentation/Help/F_CapyKit_Helpers_SecurityHelper_saltSize.md Normal file
View file

@ -0,0 +1,31 @@
# saltSize Field
Default size of the generated salt.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private const int saltSize = 32
```
**F#**
``` F#
static val mutable private saltSize: int
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

31
Documentation/Help/F_CapyKit_Password_algorithm.md Normal file
View file

@ -0,0 +1,31 @@
# algorithm Field
\[Missing &lt;summary&gt; documentation for "F:CapyKit.Password.algorithm"\]
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private static Lazy<Pbkdf2Algorithm> algorithm
```
**F#**
``` F#
static val mutable private algorithm: Lazy<Pbkdf2Algorithm>
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.lazy-1" target="_blank" rel="noopener noreferrer">Lazy</a>(<a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm</a>)
## See Also
#### Reference
<a href="T_CapyKit_Password.md">Password Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

6
Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md
View file

@ -6,7 +6,7 @@ The default number of iterations.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -30,5 +30,5 @@ This member is immutable.
#### Reference #### Reference
<a href="T_CapyKit_Pbkdf2Algorithm">Pbkdf2Algorithm Class</a> <a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

6
Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md
View file

@ -6,7 +6,7 @@
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -30,5 +30,5 @@ This member is immutable.
#### Reference #### Reference
<a href="T_CapyKit_Pbkdf2Algorithm">Pbkdf2Algorithm Class</a> <a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

31
Documentation/Help/F_CapyKit_PoolItem_1_index.md Normal file
View file

@ -0,0 +1,31 @@
# index Field
The zero-based index of the pooled item.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private readonly int index
```
**F#**
``` F#
val private index: int
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
## See Also
#### Reference
<a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

31
Documentation/Help/F_CapyKit_PoolItem_1_item.md Normal file
View file

@ -0,0 +1,31 @@
# item Field
The pooled item.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private readonly T item
```
**F#**
``` F#
val private item: 'T
```
#### Field Value
<a href="T_CapyKit_PoolItem_1.md">T</a>
## See Also
#### Reference
<a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

31
Documentation/Help/F_CapyKit_PoolItem_1_locked.md Normal file
View file

@ -0,0 +1,31 @@
# locked Field
A flag indicating whether the item is locked or not.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private bool locked
```
**F#**
``` F#
val mutable private locked: bool
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>
## See Also
#### Reference
<a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

31
Documentation/Help/F_CapyKit_PoolItem_1_typeName.md Normal file
View file

@ -0,0 +1,31 @@
# typeName Field
The name of the pooled item <a href="https://learn.microsoft.com/dotnet/api/system.type" target="_blank" rel="noopener noreferrer">Type</a>.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private readonly string typeName
```
**F#**
``` F#
val private typeName: string
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
## See Also
#### Reference
<a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

31
Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md Normal file
View file

@ -0,0 +1,31 @@
# poolItemCollection Field
The collection of pooled items.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private readonly ConcurrentBag<PoolItem<T>> poolItemCollection
```
**F#**
``` F#
val private poolItemCollection: ConcurrentBag<PoolItem<'T>>
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.collections.concurrent.concurrentbag-1" target="_blank" rel="noopener noreferrer">ConcurrentBag</a>(<a href="T_CapyKit_PoolItem_1.md">PoolItem</a>(<a href="T_CapyKit_Pool_1.md">T</a>))
## See Also
#### Reference
<a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

31
Documentation/Help/F_CapyKit_Pool_1_poolSize.md Normal file
View file

@ -0,0 +1,31 @@
# poolSize Field
(Immutable) The number of items in the pool.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private readonly int poolSize
```
**F#**
``` F#
val private poolSize: int
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
## See Also
#### Reference
<a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

31
Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md Normal file
View file

@ -0,0 +1,31 @@
# expression Field
The expression to retrieve the property.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private Func<T, U> expression
```
**F#**
``` F#
val mutable private expression: Func<'T, 'U>
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(<a href="T_CapyKit_PropertyComparer_2.md">T</a>, <a href="T_CapyKit_PropertyComparer_2.md">U</a>)
## See Also
#### Reference
<a href="T_CapyKit_PropertyComparer_2.md">PropertyComparer(T, U) Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

18
Documentation/Help/Fields_T_CapyKit_CapyEventReporter.md Normal file
View file

@ -0,0 +1,18 @@
# CapyEventReporter Fields
## Fields
<table>
<tr>
<td><a href="F_CapyKit_CapyEventReporter_uniqueIdentifiers.md">uniqueIdentifiers</a></td>
<td>A hash set storing unique identifiers for events intended to only be emitted once.</td></tr>
</table>
## See Also
#### Reference
<a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

30
Documentation/Help/Fields_T_CapyKit_Helpers_SecurityHelper.md Normal file
View file

@ -0,0 +1,30 @@
# SecurityHelper Fields
## Fields
<table>
<tr>
<td><a href="F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md">LOWER_CASE_CHARACTERS</a></td>
<td>A string of all the lower case characters.</td></tr>
<tr>
<td><a href="F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md">NUMBER_CHARACTERS</a></td>
<td>A string of all the numeric characters.</td></tr>
<tr>
<td><a href="F_CapyKit_Helpers_SecurityHelper_saltSize.md">saltSize</a></td>
<td>Default size of the generated salt.</td></tr>
<tr>
<td><a href="F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md">SPECIAL_CHARACTERS</a></td>
<td>A string of the most common non-alphanumeric characters.</td></tr>
<tr>
<td><a href="F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md">UPPER_CASE_CHARACTERS</a></td>
<td>A string of all the upper case characters.</td></tr>
</table>
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

18
Documentation/Help/Fields_T_CapyKit_Password.md Normal file
View file

@ -0,0 +1,18 @@
# Password Fields
## Fields
<table>
<tr>
<td><a href="F_CapyKit_Password_algorithm.md">algorithm</a></td>
<td> </td></tr>
</table>
## See Also
#### Reference
<a href="T_CapyKit_Password.md">Password Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

8
Documentation/Help/Fields_T_CapyKit_Pbkdf2Algorithm.md
View file

@ -6,10 +6,10 @@
## Fields ## Fields
<table> <table>
<tr> <tr>
<td><a href="F_CapyKit_Pbkdf2Algorithm_ITERATIONS">ITERATIONS</a></td> <td><a href="F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md">ITERATIONS</a></td>
<td>The default number of iterations.</td></tr> <td>The default number of iterations.</td></tr>
<tr> <tr>
<td><a href="F_CapyKit_Pbkdf2Algorithm_LENGTH">LENGTH</a></td> <td><a href="F_CapyKit_Pbkdf2Algorithm_LENGTH.md">LENGTH</a></td>
<td>(Immutable) The default length.</td></tr> <td>(Immutable) The default length.</td></tr>
</table> </table>
@ -17,5 +17,5 @@
#### Reference #### Reference
<a href="T_CapyKit_Pbkdf2Algorithm">Pbkdf2Algorithm Class</a> <a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

27
Documentation/Help/Fields_T_CapyKit_PoolItem_1.md Normal file
View file

@ -0,0 +1,27 @@
# PoolItem&lt;T&gt; Fields
## Fields
<table>
<tr>
<td><a href="F_CapyKit_PoolItem_1_index.md">index</a></td>
<td>The zero-based index of the pooled item.</td></tr>
<tr>
<td><a href="F_CapyKit_PoolItem_1_item.md">item</a></td>
<td>The pooled item.</td></tr>
<tr>
<td><a href="F_CapyKit_PoolItem_1_locked.md">locked</a></td>
<td>A flag indicating whether the item is locked or not.</td></tr>
<tr>
<td><a href="F_CapyKit_PoolItem_1_typeName.md">typeName</a></td>
<td>The name of the pooled item <a href="https://learn.microsoft.com/dotnet/api/system.type" target="_blank" rel="noopener noreferrer">Type</a>.</td></tr>
</table>
## See Also
#### Reference
<a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

21
Documentation/Help/Fields_T_CapyKit_Pool_1.md Normal file
View file

@ -0,0 +1,21 @@
# Pool&lt;T&gt; Fields
## Fields
<table>
<tr>
<td><a href="F_CapyKit_Pool_1_poolItemCollection.md">poolItemCollection</a></td>
<td>The collection of pooled items.</td></tr>
<tr>
<td><a href="F_CapyKit_Pool_1_poolSize.md">poolSize</a></td>
<td>(Immutable) The number of items in the pool.</td></tr>
</table>
## See Also
#### Reference
<a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

18
Documentation/Help/Fields_T_CapyKit_PropertyComparer_2.md Normal file
View file

@ -0,0 +1,18 @@
# PropertyComparer&lt;T, U&gt; Fields
## Fields
<table>
<tr>
<td><a href="F_CapyKit_PropertyComparer_2_expression.md">expression</a></td>
<td>The expression to retrieve the property.</td></tr>
</table>
## See Also
#### Reference
<a href="T_CapyKit_PropertyComparer_2.md">PropertyComparer(T, U) Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

4
Documentation/Help/Home.md
View file

@ -1,4 +1,4 @@
# Welcome to the [TODO: Add project name] # CapyKit - C# Utilities
This is a sample conceptual topic. You can use this as a starting point for adding more conceptual content to your help project. This is a sample conceptual topic. You can use this as a starting point for adding more conceptual content to your help project.
@ -24,4 +24,4 @@ See the **Conceptual Content** topics in the Sandcastle Help File Builder's help
#### Other Resources #### Other Resources
<a href="7d36447b-0aab-4ce9-b5ed-e60ec5bee103">Version History</a> <a href="7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md">Version History</a>

8
Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md
View file

@ -6,7 +6,7 @@ Gets the value of the enumeration represented by this attribute.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Attributes">CapyKit.Attributes</a> **Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -24,11 +24,11 @@ new :
#### Parameters #### Parameters
<dl><dt>  <a href="T_CapyKit_Attributes_EnumerationAttribute_1">T</a></dt><dd>Initializes a new instance of the <a href="T_CapyKit_Attributes_EnumerationAttribute_1">EnumerationAttribute(T)</a> class with a specified value.</dd></dl> <dl><dt>  <a href="T_CapyKit_Attributes_EnumerationAttribute_1.md">T</a></dt><dd>Initializes a new instance of the <a href="T_CapyKit_Attributes_EnumerationAttribute_1.md">EnumerationAttribute(T)</a> class with a specified value.</dd></dl>
## See Also ## See Also
#### Reference #### Reference
<a href="T_CapyKit_Attributes_EnumerationAttribute_1">EnumerationAttribute(T) Class</a> <a href="T_CapyKit_Attributes_EnumerationAttribute_1.md">EnumerationAttribute(T) Class</a>
<a href="N_CapyKit_Attributes">CapyKit.Attributes Namespace</a> <a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>

8
Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md
View file

@ -1,12 +1,12 @@
# EnumerationDescriptionAttribute Constructor # EnumerationDescriptionAttribute Constructor
Initializes a new instance of the <a href="T_CapyKit_Attributes_EnumerationDescriptionAttribute">EnumerationDescriptionAttribute</a> class with the specified description. Initializes a new instance of the <a href="T_CapyKit_Attributes_EnumerationDescriptionAttribute.md">EnumerationDescriptionAttribute</a> class with the specified description.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Attributes">CapyKit.Attributes</a> **Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -30,5 +30,5 @@ new :
#### Reference #### Reference
<a href="T_CapyKit_Attributes_EnumerationDescriptionAttribute">EnumerationDescriptionAttribute Class</a> <a href="T_CapyKit_Attributes_EnumerationDescriptionAttribute.md">EnumerationDescriptionAttribute Class</a>
<a href="N_CapyKit_Attributes">CapyKit.Attributes Namespace</a> <a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>

8
Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md
View file

@ -6,7 +6,7 @@ Initializes a new instance of the CapyEventArgs class with the specified event l
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -32,11 +32,11 @@ new :
#### Parameters #### Parameters
<dl><dt>  <a href="T_CapyKit_EventLevel">EventLevel</a></dt><dd>The severity level of the event.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>A descriptive message explaining the reason for the event.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>  (Optional)</dt><dd>The name of the method where the event was raised.</dd></dl> <dl><dt>  <a href="T_CapyKit_EventLevel.md">EventLevel</a></dt><dd>The severity level of the event.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>A descriptive message explaining the reason for the event.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>  (Optional)</dt><dd>The name of the method where the event was raised.</dd></dl>
## See Also ## See Also
#### Reference #### Reference
<a href="T_CapyKit_CapyEventArgs">CapyEventArgs Class</a> <a href="T_CapyKit_CapyEventArgs.md">CapyEventArgs Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

51
Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md Normal file
View file

@ -0,0 +1,51 @@
# EmitEvent Method
Emits an event with the given severity level, message, and method name.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
internal static void EmitEvent(
EventLevel eventLevel,
string message,
string method = null,
params Object[] args
)
```
**F#**
``` F#
internal static member EmitEvent :
eventLevel : EventLevel *
message : string *
?method : string *
args : Object[]
(* Defaults:
let _method = defaultArg method null
*)
-> unit
```
#### Parameters
<dl><dt>  <a href="T_CapyKit_EventLevel.md">EventLevel</a></dt><dd>The severity level of the event.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The message describing the reason for the event. String formatting for <em>args</em> is accepted.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>  (Optional)</dt><dd>(Optional) The name of the method where the event was raised.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>A variable-length parameters list containing arguments for formatting the message.</dd></dl>
## Remarks
In order to allow for efficient calling member access via <a href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute" target="_blank" rel="noopener noreferrer">CallerMemberNameAttribute</a> , it is suggested that *args* is defined explicitly for formatted messages.
## Example
CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration });
## See Also
#### Reference
<a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>
<a href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute" target="_blank" rel="noopener noreferrer">CallerMemberNameAttribute</a>

51
Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md Normal file
View file

@ -0,0 +1,51 @@
# EmitEventOnce Method
Emits an event with the given severity level, message, unique identifier, and method name one time.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
internal static void EmitEventOnce(
EventLevel eventLevel,
string message,
string uniqueIdentifier,
string method = null,
params Object[] args
)
```
**F#**
``` F#
internal static member EmitEventOnce :
eventLevel : EventLevel *
message : string *
uniqueIdentifier : string *
?method : string *
args : Object[]
(* Defaults:
let _method = defaultArg method null
*)
-> unit
```
#### Parameters
<dl><dt>  <a href="T_CapyKit_EventLevel.md">EventLevel</a></dt><dd>The severity level of the event.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The message describing the reason for the event. String formatting for <em>args</em> is accepted.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>A unique identifier for the event emission.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>  (Optional)</dt><dd>(Optional) The name of the method where the event was raised.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>A variable-length parameters list containing arguments for formatting the message.</dd></dl>
## Remarks
This method is similar to [!:EmitEvent(EventLevel, string, string, string, object[])] , but requires a unique identifier (such as a <a href="https://learn.microsoft.com/dotnet/api/system.guid" target="_blank" rel="noopener noreferrer">Guid</a>) to prevent duplicate emissions.
## See Also
#### Reference
<a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>
<a href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute" target="_blank" rel="noopener noreferrer">CallerMemberNameAttribute</a>
<a href="https://learn.microsoft.com/dotnet/api/system.guid" target="_blank" rel="noopener noreferrer">Guid</a>

8
Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md
View file

@ -6,7 +6,7 @@ Subscribes the specified event handler to the event with the given subscription
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -32,7 +32,7 @@ static member Subscribe :
#### Parameters #### Parameters
<dl><dt>  <a href="T_CapyKit_CapyEventHandler">CapyEventHandler</a></dt><dd>The event handler to subscribe.</dd><dt>  <a href="T_CapyKit_EventLevel">EventLevel</a></dt><dd>The severity level of the event to subscribe to.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>  (Optional)</dt><dd>(Optional) The name of the method or class where the subscription is made.</dd></dl> <dl><dt>  <a href="T_CapyKit_CapyEventHandler.md">CapyEventHandler</a></dt><dd>The event handler to subscribe.</dd><dt>  <a href="T_CapyKit_EventLevel.md">EventLevel</a></dt><dd>The severity level of the event to subscribe to.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>  (Optional)</dt><dd>(Optional) The name of the method or class where the subscription is made.</dd></dl>
## Remarks ## Remarks
If there is no existing list for the given subscription level, a new list is created and added to the dictionary. If there is no existing list for the given subscription level, a new list is created and added to the dictionary.
@ -41,5 +41,5 @@ If there is no existing list for the given subscription level, a new list is cre
#### Reference #### Reference
<a href="T_CapyKit_CapyEventReporter">CapyEventReporter Class</a> <a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

8
Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md
View file

@ -6,7 +6,7 @@ Unsubscribes the specified event handler from the event with the given origin.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -26,11 +26,11 @@ static member Unsubscribe :
#### Parameters #### Parameters
<dl><dt>  <a href="T_CapyKit_CapyEventHandler">CapyEventHandler</a></dt><dd>The event handler to unsubscribe.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The name of the method or class where the subscription was made.</dd></dl> <dl><dt>  <a href="T_CapyKit_CapyEventHandler.md">CapyEventHandler</a></dt><dd>The event handler to unsubscribe.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The name of the method or class where the subscription was made.</dd></dl>
## See Also ## See Also
#### Reference #### Reference
<a href="T_CapyKit_CapyEventReporter">CapyEventReporter Class</a> <a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

28
Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md Normal file
View file

@ -0,0 +1,28 @@
# CapyEventReporter Constructor
Initializes the static fields of the <a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter</a> class
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
static CapyEventReporter()
```
**F#**
``` F#
new : unit -> CapyEventReporter
```
## See Also
#### Reference
<a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

6
Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md
View file

@ -6,7 +6,7 @@ An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank"
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -42,5 +42,5 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_EnumerationExtensions">EnumerationExtensions Class</a> <a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

6
Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md
View file

@ -6,7 +6,7 @@ An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank"
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -42,5 +42,5 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_EnumerationExtensions">EnumerationExtensions Class</a> <a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

6
Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md
View file

@ -6,7 +6,7 @@ An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank"
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -42,5 +42,5 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_EnumerationExtensions">EnumerationExtensions Class</a> <a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

6
Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md
View file

@ -6,7 +6,7 @@ An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank"
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -42,5 +42,5 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_EnumerationExtensions">EnumerationExtensions Class</a> <a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

8
Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md
View file

@ -6,7 +6,7 @@ A *T* extension method that parses a string into an enumeration.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -49,6 +49,6 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_EnumerationExtensions">EnumerationExtensions Class</a> <a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
<a href="Overload_CapyKit_Extensions_EnumerationExtensions_Parse">Parse Overload</a> <a href="Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md">Parse Overload</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

8
Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md
View file

@ -6,7 +6,7 @@ A *T* extension method that parses a string into an enumeration.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -51,6 +51,6 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_EnumerationExtensions">EnumerationExtensions Class</a> <a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
<a href="Overload_CapyKit_Extensions_EnumerationExtensions_Parse">Parse Overload</a> <a href="Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md">Parse Overload</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

6
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md
View file

@ -6,7 +6,7 @@ Enumerates distinct items in this collection as defined by the key *property*.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -48,5 +48,5 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_LINQExtensions">LINQExtensions Class</a> <a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

8
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md
View file

@ -6,7 +6,7 @@ Filters out items matching a *predicate* from the collection.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -48,6 +48,6 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_LINQExtensions">LINQExtensions Class</a> <a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
<a href="Overload_CapyKit_Extensions_LINQExtensions_Filter">Filter Overload</a> <a href="Overload_CapyKit_Extensions_LINQExtensions_Filter.md">Filter Overload</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

8
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md
View file

@ -6,7 +6,7 @@ Filters out items matching a *predicate* from the collection.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -48,6 +48,6 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_LINQExtensions">LINQExtensions Class</a> <a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
<a href="Overload_CapyKit_Extensions_LINQExtensions_Filter">Filter Overload</a> <a href="Overload_CapyKit_Extensions_LINQExtensions_Filter.md">Filter Overload</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

8
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md
View file

@ -6,7 +6,7 @@ An IEnumable&lt;T&gt; extension method that left outer join.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -60,6 +60,6 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_LINQExtensions">LINQExtensions Class</a> <a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
<a href="Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin">LeftOuterJoin Overload</a> <a href="Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md">LeftOuterJoin Overload</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

8
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md
View file

@ -6,7 +6,7 @@ An IQueryable&lt;T&gt; extension method that left outer join.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -60,6 +60,6 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_LINQExtensions">LINQExtensions Class</a> <a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
<a href="Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin">LeftOuterJoin Overload</a> <a href="Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md">LeftOuterJoin Overload</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

59
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md Normal file
View file

@ -0,0 +1,59 @@
# LeftOuterJoin&lt;T, U, TKey, R&gt;(IQueryable&lt;T&gt;, IQueryable&lt;U&gt;, Expression&lt;Func&lt;T, TKey&gt;&gt;, Expression&lt;Func&lt;U, TKey&gt;&gt;, Expression&lt;Func&lt;T, IEnumerable&lt;U&gt;, R&gt;&gt;) Method
An IQueryable&lt;T&gt; extension method that left outer join.
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private static IQueryable<R> LeftOuterJoin<T, U, TKey, R>(
this IQueryable<T> source,
IQueryable<U> inner,
Expression<Func<T, TKey>> outerSelector,
Expression<Func<U, TKey>> innerSelector,
Expression<Func<T, IEnumerable<U>, R>> resultSelector
)
```
**F#**
``` F#
[<ExtensionAttribute>]
private static member LeftOuterJoin :
source : IQueryable<'T> *
inner : IQueryable<'U> *
outerSelector : Expression<Func<'T, 'TKey>> *
innerSelector : Expression<Func<'U, 'TKey>> *
resultSelector : Expression<Func<'T, IEnumerable<'U>, 'R>> -> IQueryable<'R>
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T)</dt><dd>The source to act on.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(U)</dt><dd>The inner.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1" target="_blank" rel="noopener noreferrer">Expression</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(T, TKey))</dt><dd>The outer selector.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1" target="_blank" rel="noopener noreferrer">Expression</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(U, TKey))</dt><dd>The inner selector.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1" target="_blank" rel="noopener noreferrer">Expression</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-3" target="_blank" rel="noopener noreferrer">Func</a>(T, <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(U), R))</dt><dd>The result selector.</dd></dl>
#### Type Parameters
<dl><dt /><dd>Generic type parameter.</dd><dt /><dd>Generic type parameter.</dd><dt /><dd>Type of the key.</dd><dt /><dd>Type of the r.</dd></dl>
#### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(R)
An IQueryable&lt;R&gt;
#### Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
Extension Methods (C# Programming Guide)</a>.
## See Also
#### Reference
<a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
<a href="Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md">LeftOuterJoin Overload</a>
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

8
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md
View file

@ -6,7 +6,7 @@ The number of pages of *pageSize* size in the given collection.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -55,6 +55,6 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_LINQExtensions">LINQExtensions Class</a> <a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
<a href="Overload_CapyKit_Extensions_LINQExtensions_PageCount">PageCount Overload</a> <a href="Overload_CapyKit_Extensions_LINQExtensions_PageCount.md">PageCount Overload</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

8
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md
View file

@ -6,7 +6,7 @@ The number of pages of *pageSize* size in the given collection.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -55,6 +55,6 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_LINQExtensions">LINQExtensions Class</a> <a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
<a href="Overload_CapyKit_Extensions_LINQExtensions_PageCount">PageCount Overload</a> <a href="Overload_CapyKit_Extensions_LINQExtensions_PageCount.md">PageCount Overload</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

8
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md
View file

@ -6,7 +6,7 @@ Get a page of items from a collection, skipping *pageNumber* pages of *pageSize*
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -60,6 +60,6 @@ This method uses natural numbering starting at page 1.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_LINQExtensions">LINQExtensions Class</a> <a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
<a href="Overload_CapyKit_Extensions_LINQExtensions_Page">Page Overload</a> <a href="Overload_CapyKit_Extensions_LINQExtensions_Page.md">Page Overload</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

8
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md
View file

@ -6,7 +6,7 @@ Get a page of items from a collection, skipping *pageNumber* pages of *pageSize*
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -60,6 +60,6 @@ This method uses natural numbering starting at page 1.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_LINQExtensions">LINQExtensions Class</a> <a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
<a href="Overload_CapyKit_Extensions_LINQExtensions_Page">Page Overload</a> <a href="Overload_CapyKit_Extensions_LINQExtensions_Page.md">Page Overload</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>

6
Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md
View file

@ -6,7 +6,7 @@ Replaces a null or empty string with a specified replacement string.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -44,6 +44,6 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_StringExtensions">StringExtensions Class</a> <a href="T_CapyKit_Extensions_StringExtensions.md">StringExtensions Class</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
<a href="https://learn.microsoft.com/dotnet/api/system.string.isnullorempty" target="_blank" rel="noopener noreferrer">IsNullOrEmpty(String)</a> <a href="https://learn.microsoft.com/dotnet/api/system.string.isnullorempty" target="_blank" rel="noopener noreferrer">IsNullOrEmpty(String)</a>

6
Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md
View file

@ -6,7 +6,7 @@ Replaces a null or whitespace string with a specified replacement string.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -44,6 +44,6 @@ Extension Methods (C# Programming Guide)</a>.
#### Reference #### Reference
<a href="T_CapyKit_Extensions_StringExtensions">StringExtensions Class</a> <a href="T_CapyKit_Extensions_StringExtensions.md">StringExtensions Class</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a> <a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
<a href="https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace" target="_blank" rel="noopener noreferrer">IsNullOrWhiteSpace(String)</a> <a href="https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace" target="_blank" rel="noopener noreferrer">IsNullOrWhiteSpace(String)</a>

6
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md
View file

@ -6,7 +6,7 @@ Compresses a given object using the `gzip` algorithm.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -34,5 +34,5 @@ A byte array representing the compressed object in `gzip` format.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_CompressionHelper">CompressionHelper Class</a> <a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

6
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md
View file

@ -6,7 +6,7 @@ Compresses a given object to a string using `base64` encoding of `gzip` format.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -34,5 +34,5 @@ A string in `base64` encoding.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_CompressionHelper">CompressionHelper Class</a> <a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

6
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md
View file

@ -6,7 +6,7 @@ Decompresses the given `base64` string in `gzip` format.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -34,5 +34,5 @@ A decomressed string.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_CompressionHelper">CompressionHelper Class</a> <a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

8
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md
View file

@ -6,7 +6,7 @@ Decompresses a given compressed `gzip` byte stream.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -38,6 +38,6 @@ A *T* typed object.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_CompressionHelper">CompressionHelper Class</a> <a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper Class</a>
<a href="Overload_CapyKit_Helpers_CompressionHelper_Decompress">Decompress Overload</a> <a href="Overload_CapyKit_Helpers_CompressionHelper_Decompress.md">Decompress Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

8
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md
View file

@ -6,7 +6,7 @@ Decompresses a given `base64` encoded string of `gzip` format.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -38,6 +38,6 @@ A *T* typed object.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_CompressionHelper">CompressionHelper Class</a> <a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper Class</a>
<a href="Overload_CapyKit_Helpers_CompressionHelper_Decompress">Decompress Overload</a> <a href="Overload_CapyKit_Helpers_CompressionHelper_Decompress.md">Decompress Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

6
Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md
View file

@ -6,7 +6,7 @@ Converts camel case text to human readable text.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -34,5 +34,5 @@ A string in human readable format.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_LanguageHelper">LanguageHelper Class</a> <a href="T_CapyKit_Helpers_LanguageHelper.md">LanguageHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

8
Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md
View file

@ -1,12 +1,12 @@
# LanguageHelper Constructor # LanguageHelper Constructor
Initializes a new instance of the <a href="T_CapyKit_Helpers_LanguageHelper">LanguageHelper</a> class Initializes a new instance of the <a href="T_CapyKit_Helpers_LanguageHelper.md">LanguageHelper</a> class
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -24,5 +24,5 @@ new : unit -> LanguageHelper
#### Reference #### Reference
<a href="T_CapyKit_Helpers_LanguageHelper">LanguageHelper Class</a> <a href="T_CapyKit_Helpers_LanguageHelper.md">LanguageHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

6
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md
View file

@ -6,7 +6,7 @@ Compares an unencrypted *providedPassword* with a stored, encrypted *existingPas
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -36,5 +36,5 @@ true if hash comparison succeeds, false if it fails.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a> <a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

6
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md
View file

@ -6,7 +6,7 @@ Compares two session identifiers.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -36,5 +36,5 @@ true if comparison succeeds, false if not.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a> <a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

43
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md Normal file
View file

@ -0,0 +1,43 @@
# CompareStrings Method
Compare two strings as case sensative.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private static bool CompareStrings(
string first,
string second
)
```
**F#**
``` F#
private static member CompareStrings :
first : string *
second : string -> bool
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The first string.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The second string.</dd></dl>
#### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>
true if the comparison succeeds, false if not.
## Remarks
This method is a proxy for using <a href="https://learn.microsoft.com/dotnet/api/system.string.compare#system-string-compare(system-string-system-int32-system-string-system-int32-system-int32-system-stringcomparison)" target="_blank" rel="noopener noreferrer">Compare(String, Int32, String, Int32, Int32, StringComparison)</a> with the `StringComparison` set to <a href="https://learn.microsoft.com/dotnet/api/system.stringcomparison#system-stringcomparison-ordinal" target="_blank" rel="noopener noreferrer">Ordinal</a>.
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

38
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md Normal file
View file

@ -0,0 +1,38 @@
# GetRandomBytes Method
Generates a new byte array of the specified length with random values.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private static byte[] GetRandomBytes(
int length
)
```
**F#**
``` F#
private static member GetRandomBytes :
length : int -> byte[]
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>The desired length of the generated byte array.</dd></dl>
#### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]
A new byte array of the specified length filled with random values.
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

8
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md
View file

@ -6,7 +6,7 @@ Gets a cryptographically strong random password.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -26,7 +26,7 @@ static member GetRandomPassword :
#### Parameters #### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>The length of the password to generate.</dd><dt>  <a href="T_CapyKit_Helpers_ValidCharacterCollection">ValidCharacterCollection</a>[]</dt><dd>\[Missing &lt;param name="validCharacters"/&gt; documentation for "M:CapyKit.Helpers.SecurityHelper.GetRandomPassword(System.Int32,CapyKit.Helpers.ValidCharacterCollection[])"\]</dd></dl> <dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>The length of the password to generate.</dd><dt>  <a href="T_CapyKit_Helpers_ValidCharacterCollection.md">ValidCharacterCollection</a>[]</dt><dd>\[Missing &lt;param name="validCharacters"/&gt; documentation for "M:CapyKit.Helpers.SecurityHelper.GetRandomPassword(System.Int32,CapyKit.Helpers.ValidCharacterCollection[])"\]</dd></dl>
#### Return Value #### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
@ -36,5 +36,5 @@ The password.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a> <a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

12
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md
View file

@ -6,7 +6,7 @@ A convenience method to generate a random string of the specified length using a
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -34,8 +34,8 @@ static member GetRandomString :
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a> <a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="Overload_CapyKit_Helpers_SecurityHelper_GetRandomString">GetRandomString Overload</a> <a href="Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md">GetRandomString Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
<a href="T_CapyKit_Helpers_ValidCharacterCollection">ValidCharacterCollection</a> <a href="T_CapyKit_Helpers_ValidCharacterCollection.md">ValidCharacterCollection</a>
<a href="M_CapyKit_Helpers_SecurityHelper_GetRandomString_1">GetRandomString(Int32, ValidCharacterCollection[])</a> <a href="M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md">GetRandomString(Int32, ValidCharacterCollection[])</a>

10
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md
View file

@ -6,7 +6,7 @@ Gets a cryptographically strong random string using the character values found i
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -26,7 +26,7 @@ static member GetRandomString :
#### Parameters #### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>The length of the string to create.</dd><dt>  <a href="T_CapyKit_Helpers_ValidCharacterCollection">ValidCharacterCollection</a>[]</dt><dd>\[Missing &lt;param name="validChars"/&gt; documentation for "M:CapyKit.Helpers.SecurityHelper.GetRandomString(System.Int32,CapyKit.Helpers.ValidCharacterCollection[])"\]</dd></dl> <dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>The length of the string to create.</dd><dt>  <a href="T_CapyKit_Helpers_ValidCharacterCollection.md">ValidCharacterCollection</a>[]</dt><dd>\[Missing &lt;param name="validChars"/&gt; documentation for "M:CapyKit.Helpers.SecurityHelper.GetRandomString(System.Int32,CapyKit.Helpers.ValidCharacterCollection[])"\]</dd></dl>
#### Return Value #### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
@ -36,6 +36,6 @@ The random string.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a> <a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="Overload_CapyKit_Helpers_SecurityHelper_GetRandomString">GetRandomString Overload</a> <a href="Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md">GetRandomString Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

38
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md Normal file
View file

@ -0,0 +1,38 @@
# GetValidCharacterComposition Method
\[Missing &lt;summary&gt; documentation for "M:CapyKit.Helpers.SecurityHelper.GetValidCharacterComposition(CapyKit.Helpers.ValidCharacterCollection[])"\]
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private static string GetValidCharacterComposition(
params ValidCharacterCollection[] validCharacters
)
```
**F#**
``` F#
private static member GetValidCharacterComposition :
validCharacters : ValidCharacterCollection[] -> string
```
#### Parameters
<dl><dt>  <a href="T_CapyKit_Helpers_ValidCharacterCollection.md">ValidCharacterCollection</a>[]</dt><dd>\[Missing &lt;param name="validCharacters"/&gt; documentation for "M:CapyKit.Helpers.SecurityHelper.GetValidCharacterComposition(CapyKit.Helpers.ValidCharacterCollection[])"\]</dd></dl>
#### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
\[Missing &lt;returns&gt; documentation for "M:CapyKit.Helpers.SecurityHelper.GetValidCharacterComposition(CapyKit.Helpers.ValidCharacterCollection[])"\]
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

6
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md
View file

@ -6,7 +6,7 @@ Hashes an unencrypted password.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -34,5 +34,5 @@ The hashed password.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a> <a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

16
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md
View file

@ -1,12 +1,12 @@
# Pbkdf2(String) Method # Pbkdf2(String) Method
Generates a new <a href="T_CapyKit_Password">Password</a> object using the PBKDF2 algorithm with the provided *password*. This overload of the method generates a random salt value for added security. Generates a new <a href="T_CapyKit_Password.md">Password</a> object using the PBKDF2 algorithm with the provided *password*. This overload of the method generates a random salt value for added security.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -27,16 +27,16 @@ static member Pbkdf2 :
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The clear text password to be hashed.</dd></dl> <dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The clear text password to be hashed.</dd></dl>
#### Return Value #### Return Value
<a href="T_CapyKit_Password">Password</a> <a href="T_CapyKit_Password.md">Password</a>
A new <a href="T_CapyKit_Password">Password</a> object containing the hashed password and a randomly generated salt. A new <a href="T_CapyKit_Password.md">Password</a> object containing the hashed password and a randomly generated salt.
## Remarks ## Remarks
This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate a new password hash. The algorithm iteratively applies a pseudorandom function to the password and salt, which increases the security of the resulting hash. In this overload, a random salt value is generated using GetRandomBytes(Int32) method. This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate a new password hash. The algorithm iteratively applies a pseudorandom function to the password and salt, which increases the security of the resulting hash. In this overload, a random salt value is generated using <a href="M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md">GetRandomBytes(Int32)</a> method.
## See Also ## See Also
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a> <a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2">Pbkdf2 Overload</a> <a href="Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md">Pbkdf2 Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

14
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md
View file

@ -1,12 +1,12 @@
# Pbkdf2(String, Byte[]) Method # Pbkdf2(String, Byte[]) Method
Generates a new <a href="T_CapyKit_Password">Password</a> object using the PBKDF2 algorithm with the provided *password* and *salt*. Generates a new <a href="T_CapyKit_Password.md">Password</a> object using the PBKDF2 algorithm with the provided *password* and *salt*.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -29,8 +29,8 @@ static member Pbkdf2 :
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The clear text password to be hashed.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]</dt><dd>A random value used to add an additional layer of security to the generated hash.</dd></dl> <dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The clear text password to be hashed.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]</dt><dd>A random value used to add an additional layer of security to the generated hash.</dd></dl>
#### Return Value #### Return Value
<a href="T_CapyKit_Password">Password</a> <a href="T_CapyKit_Password.md">Password</a>
A new <a href="T_CapyKit_Password">Password</a> object containing the hashed password and salt. A new <a href="T_CapyKit_Password.md">Password</a> object containing the hashed password and salt.
## Remarks ## Remarks
This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate a new password hash. The algorithm iteratively applies a pseudorandom function to the password and salt, which increases the security of the resulting hash. This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate a new password hash. The algorithm iteratively applies a pseudorandom function to the password and salt, which increases the security of the resulting hash.
@ -39,6 +39,6 @@ This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a> <a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2">Pbkdf2 Overload</a> <a href="Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md">Pbkdf2 Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

8
Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md
View file

@ -1,12 +1,12 @@
# SecurityHelper Constructor # SecurityHelper Constructor
Initializes a new instance of the <a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper</a> class Initializes a new instance of the <a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper</a> class
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -24,5 +24,5 @@ new : unit -> SecurityHelper
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a> <a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

8
Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md
View file

@ -6,7 +6,7 @@ Deserializes an object to a given *T* type.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -45,6 +45,6 @@ A *T* object.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SerializationHelper">SerializationHelper Class</a> <a href="T_CapyKit_Helpers_SerializationHelper.md">SerializationHelper Class</a>
<a href="Overload_CapyKit_Helpers_SerializationHelper_Deserialize">Deserialize Overload</a> <a href="Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md">Deserialize Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

8
Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md
View file

@ -6,7 +6,7 @@ Deserializes an object to a given *T* type.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -45,6 +45,6 @@ A *T* object.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SerializationHelper">SerializationHelper Class</a> <a href="T_CapyKit_Helpers_SerializationHelper.md">SerializationHelper Class</a>
<a href="Overload_CapyKit_Helpers_SerializationHelper_Deserialize">Deserialize Overload</a> <a href="Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md">Deserialize Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

8
Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md
View file

@ -6,7 +6,7 @@ Deserializes a `JSON` encoded string to the given *T*.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -38,6 +38,6 @@ A *T* object.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SerializationHelper">SerializationHelper Class</a> <a href="T_CapyKit_Helpers_SerializationHelper.md">SerializationHelper Class</a>
<a href="Overload_CapyKit_Helpers_SerializationHelper_Deserialize">Deserialize Overload</a> <a href="Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md">Deserialize Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

6
Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md
View file

@ -6,7 +6,7 @@ Serializes an object to a byte array.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -34,5 +34,5 @@ A `JSON` encoded string.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SerializationHelper">SerializationHelper Class</a> <a href="T_CapyKit_Helpers_SerializationHelper.md">SerializationHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

6
Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md
View file

@ -6,7 +6,7 @@ Serializes an object to a `JSON` encoded string.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -34,5 +34,5 @@ A `JSON` encoded string.
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SerializationHelper">SerializationHelper Class</a> <a href="T_CapyKit_Helpers_SerializationHelper.md">SerializationHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

6
Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md
View file

@ -6,7 +6,7 @@ Compares the given plaintext password with an encrypted value using PBKDF2 algor
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -42,5 +42,5 @@ True if the given *password* matches the *encryptedValue*, false if they are dif
#### Reference #### Reference
<a href="T_CapyKit_IPasswordAlgorithm">IPasswordAlgorithm Interface</a> <a href="T_CapyKit_IPasswordAlgorithm.md">IPasswordAlgorithm Interface</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

6
Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md
View file

@ -6,7 +6,7 @@ Encrypts the given password using a defined algorithm.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -36,5 +36,5 @@ A byte array with the hashed *password*.
#### Reference #### Reference
<a href="T_CapyKit_IPasswordAlgorithm">IPasswordAlgorithm Interface</a> <a href="T_CapyKit_IPasswordAlgorithm.md">IPasswordAlgorithm Interface</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

6
Documentation/Help/M_CapyKit_Password_ToString.md
View file

@ -6,7 +6,7 @@ Returns a string that represents the current object.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -29,5 +29,5 @@ A string that represents the current object.
#### Reference #### Reference
<a href="T_CapyKit_Password">Password Class</a> <a href="T_CapyKit_Password.md">Password Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

28
Documentation/Help/M_CapyKit_Password__cctor.md Normal file
View file

@ -0,0 +1,28 @@
# Password Constructor
Initializes the static fields of the <a href="T_CapyKit_Password.md">Password</a> class
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
static Password()
```
**F#**
``` F#
new : unit -> Password
```
## See Also
#### Reference
<a href="T_CapyKit_Password.md">Password Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

40
Documentation/Help/M_CapyKit_Password__ctor.md Normal file
View file

@ -0,0 +1,40 @@
# Password Constructor
Constructor.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
internal Password(
string password,
byte[] salt,
IPasswordAlgorithm algorithm,
params Object[] args
)
```
**F#**
``` F#
new :
password : string *
salt : byte[] *
algorithm : IPasswordAlgorithm *
args : Object[] -> Password
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The password to be hashed.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]</dt><dd>The salt used for encryption.</dd><dt>  <a href="T_CapyKit_IPasswordAlgorithm.md">IPasswordAlgorithm</a></dt><dd>The algorithm used for password encryption.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>A variable-length parameters list containing arguments to include for the <em>algorithm</em>.</dd></dl>
## See Also
#### Reference
<a href="T_CapyKit_Password.md">Password Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

8
Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md
View file

@ -6,7 +6,7 @@ Encrypts the given password using a PBKDF2 algorithm.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -38,12 +38,12 @@ override Encrypt :
A byte array with the hashed *password*. A byte array with the hashed *password*.
#### Implements #### Implements
<a href="M_CapyKit_IPasswordAlgorithm_Encrypt">IPasswordAlgorithm.Encrypt(String, Object[])</a> <a href="M_CapyKit_IPasswordAlgorithm_Encrypt.md">IPasswordAlgorithm.Encrypt(String, Object[])</a>
## See Also ## See Also
#### Reference #### Reference
<a href="T_CapyKit_Pbkdf2Algorithm">Pbkdf2Algorithm Class</a> <a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

8
Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md
View file

@ -1,12 +1,12 @@
# Pbkdf2Algorithm Constructor # Pbkdf2Algorithm Constructor
Initializes a new instance of the <a href="T_CapyKit_Pbkdf2Algorithm">Pbkdf2Algorithm</a> class Initializes a new instance of the <a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm</a> class
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -24,5 +24,5 @@ new : unit -> Pbkdf2Algorithm
#### Reference #### Reference
<a href="T_CapyKit_Pbkdf2Algorithm">Pbkdf2Algorithm Class</a> <a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

6
Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md
View file

@ -6,7 +6,7 @@ Releases the lock on the item.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -27,5 +27,5 @@ If the item is not locked, an error event is emitted.
#### Reference #### Reference
<a href="T_CapyKit_PoolItem_1">PoolItem(T) Class</a> <a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

6
Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md
View file

@ -6,7 +6,7 @@ Sets the lock on the item indicating that it is in use.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -31,5 +31,5 @@ If the item is already locked, an error event is emitted.
#### Reference #### Reference
<a href="T_CapyKit_PoolItem_1">PoolItem(T) Class</a> <a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

6
Documentation/Help/M_CapyKit_PoolItem_1_ToString.md
View file

@ -6,7 +6,7 @@ Returns a string that represents the current object and its lock state.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -29,5 +29,5 @@ A string that represents the current object and its lock state.
#### Reference #### Reference
<a href="T_CapyKit_PoolItem_1">PoolItem(T) Class</a> <a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

36
Documentation/Help/M_CapyKit_PoolItem_1__ctor.md Normal file
View file

@ -0,0 +1,36 @@
# PoolItem&lt;T&gt; Constructor
Initializes a new instance of the <a href="T_CapyKit_PoolItem_1.md">PoolItem(T)</a> class with the specified item and index.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
internal PoolItem(
T item,
int index
)
```
**F#**
``` F#
new :
item : 'T *
index : int -> PoolItem
```
#### Parameters
<dl><dt>  <a href="T_CapyKit_PoolItem_1.md">T</a></dt><dd>The pooled item.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>The zero-based index of the pooled item.</dd></dl>
## See Also
#### Reference
<a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

35
Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection.md Normal file
View file

@ -0,0 +1,35 @@
# FillPoolItemCollection(IEnumerable&lt;T&gt;) Method
Fill the pool item collection from an existing *T* collection.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private void FillPoolItemCollection(
IEnumerable<T> collection
)
```
**F#**
``` F#
private member FillPoolItemCollection :
collection : IEnumerable<'T> -> unit
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(<a href="T_CapyKit_Pool_1.md">T</a>)</dt><dd>The <em>T</em> collection.</dd></dl>
## See Also
#### Reference
<a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
<a href="Overload_CapyKit_Pool_1_FillPoolItemCollection.md">FillPoolItemCollection Overload</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

35
Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_1.md Normal file
View file

@ -0,0 +1,35 @@
# FillPoolItemCollection(Int32) Method
Initializes the pool with the specified number of items using the default constructor.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private void FillPoolItemCollection(
int poolSize
)
```
**F#**
``` F#
private member FillPoolItemCollection :
poolSize : int -> unit
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>The size of the pool.</dd></dl>
## See Also
#### Reference
<a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
<a href="Overload_CapyKit_Pool_1_FillPoolItemCollection.md">FillPoolItemCollection Overload</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

37
Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_2.md Normal file
View file

@ -0,0 +1,37 @@
# FillPoolItemCollection(Int32, Func&lt;T&gt;) Method
Initializes the pool with the specified number of items using the specified constructor selector.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
private void FillPoolItemCollection(
int poolSize,
Func<T> constructorSelector
)
```
**F#**
``` F#
private member FillPoolItemCollection :
poolSize : int *
constructorSelector : Func<'T> -> unit
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>The size of the pool.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.func-1" target="_blank" rel="noopener noreferrer">Func</a>(<a href="T_CapyKit_Pool_1.md">T</a>)</dt><dd>The constructor selector.</dd></dl>
## See Also
#### Reference
<a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
<a href="Overload_CapyKit_Pool_1_FillPoolItemCollection.md">FillPoolItemCollection Overload</a>
<a href="N_CapyKit.md">CapyKit Namespace</a>

8
Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md
View file

@ -6,7 +6,7 @@ Gets the first available item from the pool and sets its lock.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -21,12 +21,12 @@ member GetAvailableItem : unit -> PoolItem<'T>
#### Return Value #### Return Value
<a href="T_CapyKit_PoolItem_1">PoolItem</a>(<a href="T_CapyKit_Pool_1">T</a>) <a href="T_CapyKit_PoolItem_1.md">PoolItem</a>(<a href="T_CapyKit_Pool_1.md">T</a>)
The first available item from the pool. The first available item from the pool.
## See Also ## See Also
#### Reference #### Reference
<a href="T_CapyKit_Pool_1">Pool(T) Class</a> <a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

10
Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md
View file

@ -6,7 +6,7 @@ Releases the lock on the specified item and returns it to the pool.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -24,14 +24,14 @@ member ReleaseItem :
#### Parameters #### 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> <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 ## 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>. 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 ## See Also
#### Reference #### Reference
<a href="T_CapyKit_Pool_1">Pool(T) Class</a> <a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

12
Documentation/Help/M_CapyKit_Pool_1__ctor.md
View file

@ -1,12 +1,12 @@
# Pool&lt;T&gt;(IEnumerable&lt;T&gt;) Constructor # Pool&lt;T&gt;(IEnumerable&lt;T&gt;) Constructor
Initializes a new instance of the <a href="T_CapyKit_Pool_1">Pool(T)</a> class with the specified collection of items. Initializes a new instance of the <a href="T_CapyKit_Pool_1.md">Pool(T)</a> class with the specified collection of items.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -24,12 +24,12 @@ new :
#### Parameters #### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(<a href="T_CapyKit_Pool_1">T</a>)</dt><dd>The collection of <em>T</em> items with which to seed the pool.</dd></dl> <dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(<a href="T_CapyKit_Pool_1.md">T</a>)</dt><dd>The collection of <em>T</em> items with which to seed the pool.</dd></dl>
## See Also ## See Also
#### Reference #### Reference
<a href="T_CapyKit_Pool_1">Pool(T) Class</a> <a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
<a href="Overload_CapyKit_Pool_1__ctor">Pool(T) Overload</a> <a href="Overload_CapyKit_Pool_1__ctor.md">Pool(T) Overload</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

10
Documentation/Help/M_CapyKit_Pool_1__ctor_1.md
View file

@ -1,12 +1,12 @@
# Pool&lt;T&gt;(Int32) Constructor # Pool&lt;T&gt;(Int32) Constructor
Initializes a new instance of the <a href="T_CapyKit_Pool_1">Pool(T)</a> class with the specified pool size. Initializes a new instance of the <a href="T_CapyKit_Pool_1.md">Pool(T)</a> class with the specified pool size.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -30,6 +30,6 @@ new :
#### Reference #### Reference
<a href="T_CapyKit_Pool_1">Pool(T) Class</a> <a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
<a href="Overload_CapyKit_Pool_1__ctor">Pool(T) Overload</a> <a href="Overload_CapyKit_Pool_1__ctor.md">Pool(T) Overload</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

12
Documentation/Help/M_CapyKit_Pool_1__ctor_2.md
View file

@ -1,12 +1,12 @@
# Pool&lt;T&gt;(Int32, Func&lt;T&gt;) Constructor # Pool&lt;T&gt;(Int32, Func&lt;T&gt;) Constructor
Initializes a new instance of the <a href="T_CapyKit_Pool_1">Pool(T)</a> class with the specified pool size and constructor selector. Initializes a new instance of the <a href="T_CapyKit_Pool_1.md">Pool(T)</a> class with the specified pool size and constructor selector.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -26,12 +26,12 @@ new :
#### Parameters #### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>The size of the pool.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.func-1" target="_blank" rel="noopener noreferrer">Func</a>(<a href="T_CapyKit_Pool_1">T</a>)</dt><dd>The constructor selector used to create new instances of <em>T</em>.</dd></dl> <dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>The size of the pool.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.func-1" target="_blank" rel="noopener noreferrer">Func</a>(<a href="T_CapyKit_Pool_1.md">T</a>)</dt><dd>The constructor selector used to create new instances of <em>T</em>.</dd></dl>
## See Also ## See Also
#### Reference #### Reference
<a href="T_CapyKit_Pool_1">Pool(T) Class</a> <a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
<a href="Overload_CapyKit_Pool_1__ctor">Pool(T) Overload</a> <a href="Overload_CapyKit_Pool_1__ctor.md">Pool(T) Overload</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

10
Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md
View file

@ -6,7 +6,7 @@ Determines whether the specified properties are equal.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -29,7 +29,7 @@ override Equals :
#### Parameters #### Parameters
<dl><dt>  <a href="T_CapyKit_PropertyComparer_2">T</a></dt><dd>The first object of type <em>T</em> to compare.</dd><dt>  <a href="T_CapyKit_PropertyComparer_2">T</a></dt><dd>The second object of type <em>T</em> to compare.</dd></dl> <dl><dt>  <a href="T_CapyKit_PropertyComparer_2.md">T</a></dt><dd>The first object of type <em>T</em> to compare.</dd><dt>  <a href="T_CapyKit_PropertyComparer_2.md">T</a></dt><dd>The second object of type <em>T</em> to compare.</dd></dl>
#### Return Value #### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a> <a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>
@ -43,6 +43,6 @@ true if the specified objects are equal; otherwise, false.
#### Reference #### Reference
<a href="T_CapyKit_PropertyComparer_2">PropertyComparer(T, U) Class</a> <a href="T_CapyKit_PropertyComparer_2.md">PropertyComparer(T, U) Class</a>
<a href="Overload_CapyKit_PropertyComparer_2_Equals">Equals Overload</a> <a href="Overload_CapyKit_PropertyComparer_2_Equals.md">Equals Overload</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

10
Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md
View file

@ -6,7 +6,7 @@ Returns a hash code for the specified object.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -26,7 +26,7 @@ override GetHashCode :
#### Parameters #### Parameters
<dl><dt>  <a href="T_CapyKit_PropertyComparer_2">T</a></dt><dd>The <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a> for which a hash code is to be returned.</dd></dl> <dl><dt>  <a href="T_CapyKit_PropertyComparer_2.md">T</a></dt><dd>The <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a> for which a hash code is to be returned.</dd></dl>
#### Return Value #### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a> <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
@ -47,6 +47,6 @@ A hash code for the specified object.
#### Reference #### Reference
<a href="T_CapyKit_PropertyComparer_2">PropertyComparer(T, U) Class</a> <a href="T_CapyKit_PropertyComparer_2.md">PropertyComparer(T, U) Class</a>
<a href="Overload_CapyKit_PropertyComparer_2_GetHashCode">GetHashCode Overload</a> <a href="Overload_CapyKit_PropertyComparer_2_GetHashCode.md">GetHashCode Overload</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

8
Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md
View file

@ -6,7 +6,7 @@ Constructor.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
@ -24,11 +24,11 @@ new :
#### Parameters #### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(<a href="T_CapyKit_PropertyComparer_2">T</a>, <a href="T_CapyKit_PropertyComparer_2">U</a>)</dt><dd>The expression.</dd></dl> <dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(<a href="T_CapyKit_PropertyComparer_2.md">T</a>, <a href="T_CapyKit_PropertyComparer_2.md">U</a>)</dt><dd>The expression.</dd></dl>
## See Also ## See Also
#### Reference #### Reference
<a href="T_CapyKit_PropertyComparer_2">PropertyComparer(T, U) Class</a> <a href="T_CapyKit_PropertyComparer_2.md">PropertyComparer(T, U) Class</a>
<a href="N_CapyKit">CapyKit Namespace</a> <a href="N_CapyKit.md">CapyKit Namespace</a>

Some files were not shown because too many files have changed in this diff Show more