wagesj45/CapyKit
wagesj45/CapyKit
1
0
Fork 0
mirror of https://github.com/wagesj45/CapyKit.git synced 2024-11-13 19:53:36 -06:00
Code Issues Projects Releases Packages 1 Wiki Activity

Documentation

Browse source
This commit is contained in:
Jordan Wages 2024-09-04 19:31:43 -05:00
parent 650c6ea3dd
commit b0ebf43ae9
218 changed files with 1127 additions and 579 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
CapyKit/CapyKit.csproj
View file

@ -1,10 +1,19 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
<PackageReadmeFile>README.md</PackageReadmeFile>
<Version>1.0.2</Version>
</PropertyGroup>
<ItemGroup>
<None Include="..\README.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
</ItemGroup>
</Project>

20
CapyKit/Helpers/SecurityHelper.cs
View file

@ -100,7 +100,7 @@ namespace CapyKit.Helpers
/// <seealso cref="SecurityHelper.SALT_SIZE"/>
public static Password GetPassword<T>(string password, params object[] args)
{
var salt = SecurityHelper.GetRandomBytes(SecurityHelper.SALT_SIZE);
var salt = SecurityHelper.GetSalt;
return GetPassword<T>(password, salt, args);
}
@ -278,11 +278,29 @@ namespace CapyKit.Helpers
return buffer.ToString();
}
/// <summary> Generates a random byte array that can act as a salt. </summary>
/// <remarks>
/// A default length of <see cref="SALT_SIZE"/> is provided as a sane default. Larger values can be used for increased
/// entropy.
/// </remarks>
/// <param name="length"> (Optional) The desired length of the generated byte array. </param>
/// <returns> An array of byte. </returns>
public static byte[] GetSalt(int length = SALT_SIZE)
{
return GetRandomBytes(length);
}
/// <summary> Generates a new byte array of the specified length with random values. </summary>
/// <param name="length"> The desired length of the generated byte array. </param>
/// <returns> A new byte array of the specified length filled with random values. </returns>
private static byte[] GetRandomBytes(int length)
{
if(length <= 0)
{
CapyEventReporter.EmitEvent(EventLevel.Error, "Length must be greater than 0.");
return GetRandomBytes(16);
}
var buffer = new byte[length];
using (var rng = RandomNumberGenerator.Create())
{

2
Documentation/ContentLayout.content
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<Topics>
<Topic id="849aa079-3d64-4cf1-966f-44af23c73160" visible="True" isDefault="true" isSelected="true" title="CapyKit - C# Utilities">
<Topic id="fa7407d1-9116-4ad7-a9ab-ed094685b070" visible="True" isDefault="true" isSelected="true" title="CapyKit - C# Utilities">
<HelpKeywords>
<HelpKeyword index="K" term="Welcome" />
</HelpKeywords>

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

@ -1,27 +0,0 @@
# 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.
## Getting Started
To get started, add a documentation source to the project (a Visual Studio solution, project, or assembly and XML comments file). See the **Getting Started** topics in the Sandcastle Help File Builder's help file for more information. The following default items are included in this project:
<ul><li><p><em>ContentLayout.content</em> - Use the content layout file to manage the conceptual content in the project and define its layout in the table of contents.</p></li><li><p>
The <em>.\media</em> folder - Place images in this folder that you will reference from conceptual content using <code>medialLink</code> or <code>mediaLinkInline</code> elements. If you will not have any images in the file, you may remove this folder.</p></li><li><p>
The <em>.\icons</em> folder - This contains a default logo for the help file. You may replace it or remove it and the folder if not wanted. If removed or if you change the file name, update the <strong>Transform Args</strong> project properties page by removing or changing the filename in the <code>logoFile</code> transform argument. Note that unlike images referenced from conceptual topics, the logo file should have its <strong>BuildAction</strong> property set to <code>Content</code>.</p></li><li><p>
The <em>.\Content</em> folder - Use this to store your conceptual topics. You may name the files and organize them however you like. One suggestion is to lay the files out on disk as you have them in the content layout file as shown in this project but the choice is yours. Files can be added via the Solution Explorer or from within the content layout file editor. Files must appear in the content layout file in order to be compiled into the help file.</p></li></ul>
See the **Conceptual Content** topics in the Sandcastle Help File Builder's help file for more information. See the **Sandcastle MAML Guide** for details on Microsoft Assistance Markup Language (MAML) which is used to create these topics.
## See Also
#### Other Resources
[7d36447b-0aab-4ce9-b5ed-e60ec5bee103]

2
Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md
View file

@ -7,7 +7,7 @@ A hash set storing unique identifiers for events intended to only be emitted onc
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS.md
View file

@ -7,7 +7,7 @@ The earth's radius in kilometers.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER.md
View file

@ -7,7 +7,7 @@ Ratio of miles per kilometer .
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Helpers_CalculationHelper_chars.md
View file

@ -7,7 +7,7 @@ The valid hexidecimal characters.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Helpers_EncryptionHelper_encryptionKey.md
View file

@ -7,7 +7,7 @@
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md
View file

@ -7,7 +7,7 @@ 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
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md
View file

@ -7,7 +7,7 @@ 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
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SALT_SIZE.md
View file

@ -7,7 +7,7 @@ Default size to use when generating a new salt.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md
View file

@ -7,7 +7,7 @@ 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
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md
View file

@ -7,7 +7,7 @@ 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
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Helpers_SettingsHelper_accessor.md
View file

@ -7,7 +7,7 @@ Private delegate function that retrieves a setting with the given `key`.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Helpers_SettingsHelper_detector.md
View file

@ -7,7 +7,7 @@ Private delegate function that detects if a setting with a given `key` exists. R
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Password_pbkdf2Algorithm.md
View file

@ -7,7 +7,7 @@
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md
View file

@ -7,7 +7,7 @@ The default number of iterations.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md
View file

@ -7,7 +7,7 @@
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_PoolItem_1_index.md
View file

@ -7,7 +7,7 @@ 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
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_PoolItem_1_item.md
View file

@ -7,7 +7,7 @@ The pooled item.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_PoolItem_1_locked.md
View file

@ -7,7 +7,7 @@ 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
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_PoolItem_1_typeName.md
View file

@ -7,7 +7,7 @@ The name of the pooled item <a href="https://learn.microsoft.com/dotnet/api/syst
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md
View file

@ -7,7 +7,7 @@ The collection of pooled items.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_Pool_1_poolSize.md
View file

@ -7,7 +7,7 @@
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md
View file

@ -7,7 +7,7 @@ The expression to retrieve the property.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

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

@ -0,0 +1,31 @@
# Password Field
\[Missing &lt;summary&gt; documentation for "F:Tests.Helpers.SecurityHelperTests.Password"\]
## Definition
**Namespace:** <a href="N_Tests_Helpers.md">Tests.Helpers</a>
**Assembly:** Tests (in Tests.exe) Version: 1.0.0
**C#**
``` C#
private const string Password = "TestPassword"
```
**F#**
``` F#
static val mutable private Password: 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_Tests_Helpers_SecurityHelperTests.md">SecurityHelperTests Class</a>
<a href="N_Tests_Helpers.md">Tests.Helpers Namespace</a>

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

@ -0,0 +1,31 @@
# Salt Field
\[Missing &lt;summary&gt; documentation for "F:Tests.Helpers.SecurityHelperTests.Salt"\]
## Definition
**Namespace:** <a href="N_Tests_Helpers.md">Tests.Helpers</a>
**Assembly:** Tests (in Tests.exe) Version: 1.0.0
**C#**
``` C#
private static readonly byte[] Salt
```
**F#**
``` F#
static val private Salt: byte[]
```
#### Field Value
<a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]
## See Also
#### Reference
<a href="T_Tests_Helpers_SecurityHelperTests.md">SecurityHelperTests Class</a>
<a href="N_Tests_Helpers.md">Tests.Helpers Namespace</a>

4
Documentation/Help/F_Tests_StringExtensions_Replacement.md → Documentation/Help/F_Tests_StringExtensionTests_Replacement.md
View file

@ -1,7 +1,7 @@
# Replacement Field
\[Missing &lt;summary&gt; documentation for "F:Tests.StringExtensions.Replacement"\]
\[Missing &lt;summary&gt; documentation for "F:Tests.StringExtensionTests.Replacement"\]
@ -27,5 +27,5 @@ static val mutable private Replacement: string
#### Reference
<a href="T_Tests_StringExtensions.md">StringExtensions Class</a>
<a href="T_Tests_StringExtensionTests.md">StringExtensionTests Class</a>
<a href="N_Tests.md">Tests Namespace</a>

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

@ -0,0 +1,21 @@
# SecurityHelperTests Fields
## Fields
<table>
<tr>
<td><a href="F_Tests_Helpers_SecurityHelperTests_Password.md">Password</a></td>
<td> </td></tr>
<tr>
<td><a href="F_Tests_Helpers_SecurityHelperTests_Salt.md">Salt</a></td>
<td> </td></tr>
</table>
## See Also
#### Reference
<a href="T_Tests_Helpers_SecurityHelperTests.md">SecurityHelperTests Class</a>
<a href="N_Tests_Helpers.md">Tests.Helpers Namespace</a>

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

@ -0,0 +1,18 @@
# StringExtensionTests Fields
## Fields
<table>
<tr>
<td><a href="F_Tests_StringExtensionTests_Replacement.md">Replacement</a></td>
<td> </td></tr>
</table>
## See Also
#### Reference
<a href="T_Tests_StringExtensionTests.md">StringExtensionTests Class</a>
<a href="N_Tests.md">Tests Namespace</a>

18
Documentation/Help/Fields_T_Tests_StringExtensions.md
View file

@ -1,18 +0,0 @@
# StringExtensions Fields
## Fields
<table>
<tr>
<td><a href="F_Tests_StringExtensions_Replacement.md">Replacement</a></td>
<td> </td></tr>
</table>
## See Also
#### Reference
<a href="T_Tests_StringExtensions.md">StringExtensions Class</a>
<a href="N_Tests.md">Tests Namespace</a>

18
Documentation/Help/Home.md
View file

@ -1,23 +1,11 @@
# 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.
Version [TODO: Version] was released on [TODO: Date].
## Getting Started
## Changes in This Release
<ul><li><p>[TODO: Add change items here]</p></li></ul>
To get started, add a documentation source to the project (a Visual Studio solution, project, or assembly and XML comments file). See the **Getting Started** topics in the Sandcastle Help File Builder's help file for more information. The following default items are included in this project:
<ul><li><p><em>ContentLayout.content</em> - Use the content layout file to manage the conceptual content in the project and define its layout in the table of contents.</p></li><li><p>
The <em>.\media</em> folder - Place images in this folder that you will reference from conceptual content using <code>medialLink</code> or <code>mediaLinkInline</code> elements. If you will not have any images in the file, you may remove this folder.</p></li><li><p>
The <em>.\icons</em> folder - This contains a default logo for the help file. You may replace it or remove it and the folder if not wanted. If removed or if you change the file name, update the <strong>Transform Args</strong> project properties page by removing or changing the filename in the <code>logoFile</code> transform argument. Note that unlike images referenced from conceptual topics, the logo file should have its <strong>BuildAction</strong> property set to <code>Content</code>.</p></li><li><p>
The <em>.\Content</em> folder - Use this to store your conceptual topics. You may name the files and organize them however you like. One suggestion is to lay the files out on disk as you have them in the content layout file as shown in this project but the choice is yours. Files can be added via the Solution Explorer or from within the content layout file editor. Files must appear in the content layout file in order to be compiled into the help file.</p></li></ul>
See the **Conceptual Content** topics in the Sandcastle Help File Builder's help file for more information. See the **Sandcastle MAML Guide** for details on Microsoft Assistance Markup Language (MAML) which is used to create these topics.
## See Also

2
Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md
View file

@ -7,7 +7,7 @@ Gets the value of the enumeration represented by this attribute.
## Definition
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md
View file

@ -7,7 +7,7 @@ Initializes a new instance of the <a href="T_CapyKit_Attributes_EnumerationDescr
## Definition
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString.md
View file

@ -7,7 +7,7 @@ Gets a parameterized formatted string for the specified index.
## Definition
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute__ctor.md
View file

@ -7,7 +7,7 @@ Default constructor. Initializes a new instance of the <a href="T_CapyKit_Attrib
## Definition
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute__ctor_1.md
View file

@ -7,7 +7,7 @@ Constructor. Initializes a new instance of the <a href="T_CapyKit_Attributes_Val
## Definition
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md
View file

@ -7,7 +7,7 @@ Initializes a new instance of the CapyEventArgs class with the specified event l
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md
View file

@ -7,7 +7,7 @@ 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
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md
View file

@ -7,7 +7,7 @@ Emits an event with the given severity level, message, unique identifier, and me
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md
View file

@ -7,7 +7,7 @@ Subscribes the specified event handler to the event with the given subscription
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md
View file

@ -7,7 +7,7 @@ Unsubscribes the specified event handler from the event with the given origin.
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md
View file

@ -7,7 +7,7 @@ Initializes the static fields of the <a href="T_CapyKit_CapyEventReporter.md">Ca
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_EncryptedValue_1__ctor.md
View file

@ -7,7 +7,7 @@ Initializes a new instance of the <a href="T_CapyKit_EncryptedValue_1.md">Encryp
## Definition
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md
View file

@ -7,7 +7,7 @@ An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank"
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md
View file

@ -7,7 +7,7 @@ An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank"
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md
View file

@ -7,7 +7,7 @@ An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank"
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md
View file

@ -7,7 +7,7 @@ An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank"
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md
View file

@ -7,7 +7,7 @@ A *T* extension method that parses a string into an enumeration.
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md
View file

@ -7,7 +7,7 @@ A *T* extension method that parses a string into an enumeration.
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md
View file

@ -7,7 +7,7 @@ Enumerates distinct items in this collection as defined by the key *property*.
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md
View file

@ -7,7 +7,7 @@ Filters out items matching a *predicate* from the collection.
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md
View file

@ -7,7 +7,7 @@ Filters out items matching a *predicate* from the collection.
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md
View file

@ -7,7 +7,7 @@ An IEnumable&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
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md
View file

@ -7,7 +7,7 @@ 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
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md
View file

@ -7,7 +7,7 @@ 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
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md
View file

@ -7,7 +7,7 @@ The number of pages of *pageSize* size in the given collection.
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md
View file

@ -7,7 +7,7 @@ The number of pages of *pageSize* size in the given collection.
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md
View file

@ -7,7 +7,7 @@ Get a page of items from a collection, skipping *pageNumber* pages of *pageSize*
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md
View file

@ -7,7 +7,7 @@ Get a page of items from a collection, skipping *pageNumber* pages of *pageSize*
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md
View file

@ -7,7 +7,7 @@ Replaces a null or empty string with a specified replacement string.
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md
View file

@ -7,7 +7,7 @@ Replaces a null or whitespace string with a specified replacement string.
## Definition
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CalculationHelper_CalculateHash.md
View file

@ -7,7 +7,7 @@ Calculates the hash of a given string using an <a href="https://learn.microsoft.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CalculationHelper_CalculateHexHash.md
View file

@ -7,7 +7,7 @@ Calculates the hexadecimal hash.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CalculationHelper_DegreesToRadians.md
View file

@ -7,7 +7,7 @@ Convers degrees to radians.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CalculationHelper_GetDistance.md
View file

@ -7,7 +7,7 @@ Gets the distance between two points on earth using the `haversine` formula.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CalculationHelper_GetDistance_1.md
View file

@ -7,7 +7,7 @@ Gets the distance between two points on earth using the `haversine` formula.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CalculationHelper_KilometersToMiles.md
View file

@ -7,7 +7,7 @@ Converts kilometers to miles.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CalculationHelper_MilesToKilometers.md
View file

@ -7,7 +7,7 @@ Converts miles to kilometers.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CalculationHelper_RadiansToDegrees.md
View file

@ -7,7 +7,7 @@ Converts radians to degrees.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md
View file

@ -7,7 +7,7 @@ Compresses a given object using the `gzip` algorithm.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md
View file

@ -7,7 +7,7 @@ Compresses a given object to a string using `base64` encoding of `gzip` format.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md
View file

@ -7,7 +7,7 @@ Decompresses the given `base64` string in `gzip` format.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md
View file

@ -7,7 +7,7 @@ Decompresses a given compressed `gzip` byte stream.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md
View file

@ -7,7 +7,7 @@ Decompresses a given `base64` encoded string of `gzip` format.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_EncryptionHelper__ctor.md
View file

@ -7,7 +7,7 @@ Initializes a new instance of the <a href="T_CapyKit_Helpers_EncryptionHelper.md
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1.md
View file

@ -7,7 +7,7 @@
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1.md
View file

@ -7,7 +7,7 @@
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md
View file

@ -7,7 +7,7 @@ Converts camel case text to human readable text.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md
View file

@ -7,7 +7,7 @@ Initializes a new instance of the <a href="T_CapyKit_Helpers_LanguageHelper.md">
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md
View file

@ -7,7 +7,7 @@ Compares an unencrypted *password* with a stored, encrypted *existingPassword*.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1.md
View file

@ -7,7 +7,7 @@ Compares an unencrypted *password* with a stored, encrypted *existingPassword*.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md
View file

@ -7,7 +7,7 @@ Compares two session identifiers.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md
View file

@ -7,7 +7,7 @@ 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
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md
View file

@ -7,7 +7,7 @@ Retrieves a <a href="T_CapyKit_Password.md">Password</a> object using the specif
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetPassword__1_1.md
View file

@ -7,7 +7,7 @@ Retrieves a <a href="T_CapyKit_Password.md">Password</a> object using the specif
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md
View file

@ -7,7 +7,7 @@ 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
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md
View file

@ -7,7 +7,7 @@ Gets a cryptographically strong random password.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md
View file

@ -7,7 +7,7 @@ A convenience method to generate a random string of the specified length using a
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md
View file

@ -7,7 +7,7 @@ Gets a cryptographically strong random string using the character values found i
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

45
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetSalt.md Normal file
View file

@ -0,0 +1,45 @@
# GetSalt Method
Generates a random byte array that can act as a salt.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#
public static byte[] GetSalt(
int length = 32
)
```
**F#**
``` F#
static member GetSalt :
?length : int
(* Defaults:
let _length = defaultArg length 32
*)
-> byte[]
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>  (Optional)</dt><dd>(Optional) 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>[]
An array of byte.
## Remarks
A default length of <a href="F_CapyKit_Helpers_SecurityHelper_SALT_SIZE.md">SALT_SIZE</a> is provided as a sane default. Larger values can be used for increased entropy.
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md
View file

@ -7,7 +7,7 @@ Static method that returns a valid character composition based on the given Vali
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md
View file

@ -7,7 +7,7 @@ Generates a new <a href="T_CapyKit_Password.md">Password</a> object using the PB
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md
View file

@ -7,7 +7,7 @@ Generates a new <a href="T_CapyKit_Password.md">Password</a> object using the PB
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md
View file

@ -7,7 +7,7 @@ Initializes a new instance of the <a href="T_CapyKit_Helpers_SecurityHelper.md">
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md
View file

@ -7,7 +7,7 @@ Deserializes an object to a given *T* type.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md
View file

@ -7,7 +7,7 @@ Deserializes an object to a given *T* type.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md
View file

@ -7,7 +7,7 @@ Deserializes a `JSON` encoded string to the given *T*.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

2
Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md
View file

@ -7,7 +7,7 @@ Serializes an object to a byte array.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#

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