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

Security Helper & Documentation

Browse source
This commit is contained in:
Jordan Wages 2024-04-21 01:20:26 -05:00
parent 735d7c4c91
commit cbdeded5be
108 changed files with 569 additions and 1444 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

212
CapyKit/Helpers/SecurityHelper.cs
View file

@ -1,6 +1,9 @@
using System; using CapyKit.Attributes;
using CapyKit.Extensions;
using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq; using System.Linq;
using System.Reflection.Metadata.Ecma335;
using System.Security.Cryptography; using System.Security.Cryptography;
using System.Text; using System.Text;
using System.Threading.Tasks; using System.Threading.Tasks;
@ -12,23 +15,20 @@ namespace CapyKit.Helpers
{ {
#region Members #region Members
private int keySize = 32; /// <summary> Default size of the generated salt. </summary>
private int saltSize = 32; private const int saltSize = 32;
/// <summary> The salt used when creating a hash using the <a href="https://en.wikipedia.org/wiki/SHA-2">SHA256</a> algorithm. </summary>
private const string SALT = "D4260471-5DBA-4732-B960-6E2E438F8872";
/// <summary> A string of all the lower case characters. </summary> /// <summary> A string of all the lower case characters. </summary>
private const string LOWER_CASE_CHARACTERS = "abcdefghijklmnopqrstuvwxyz"; internal const string LOWER_CASE_CHARACTERS = "abcdefghijklmnopqrstuvwxyz";
/// <summary> A string of all the upper case characters. </summary> /// <summary> A string of all the upper case characters. </summary>
private const string UPPER_CASE_CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"; internal const string UPPER_CASE_CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
/// <summary> A string of all the numeric characters. </summary> /// <summary> A string of all the numeric characters. </summary>
private const string NUMBER_CHARACTERS = "0123456789"; internal const string NUMBER_CHARACTERS = "0123456789";
/// <summary> A string of the most common non-alphanumeric characters. </summary> /// <summary> A string of the most common non-alphanumeric characters. </summary>
private const string SPECIAL_CHARACTERS = "!@#$%&?+-_"; internal const string SPECIAL_CHARACTERS = "!@#$%&?+-_";
#endregion Members #endregion Members
@ -57,51 +57,56 @@ namespace CapyKit.Helpers
} }
/// <summary> /// <summary>
/// Produces a <a href="https://en.wikipedia.org/wiki/SHA-2">SHA256</a> hash from a given /// Generates a new <see cref="Password"/> object using the PBKDF2 algorithm with the provided <paramref name="password"/>
/// <paramref name="value"/>. /// and <paramref name="salt"/>.
/// </summary> /// </summary>
/// <param name="value"> The value. </param> /// <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.
/// </remarks>
/// <param name="password"> The clear text password to be hashed. </param>
/// <param name="salt">
/// A random value used to add an additional layer of security to the generated hash.
/// </param>
/// <returns> /// <returns>
/// A byte array equal to the SHA256 hash of <paramref name="value"/> or an empty array if it /// A new <see cref="Password"/> object containing the hashed password and salt.
/// fails.
/// </returns> /// </returns>
public static byte[] SHA256Hash(string value) public static Password Pbkdf2(string password, byte[] salt)
{ {
try var pwd = new Password(password, salt, Password.Pbkdf2Algorithm);
{
using (var hash = new SHA256Managed()) return pwd;
{
var bytes = Encoding.Unicode.GetBytes(value + SALT);
var encrypted = hash.ComputeHash(bytes);
return encrypted;
}
}
catch (Exception ex)
{
CapyEventReporter.EmitEvent(EventLevel.Error, "Could not hash the given value {0}.", args: new[] { value });
} }
return new byte[0]; /// <summary>
} /// Generates a new <see cref="Password"/> object using the PBKDF2 algorithm with the provided <paramref name="password"/>.
/// This overload of the method generates a random salt value for added security.
public static string Pbkdf2(string password, out byte[] salt) /// </summary>
/// <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 <see cref="SecurityHelper.GetRandomBytes(int)"/> method.
/// </remarks>
/// <param name="password"> The clear text password to be hashed. </param>
/// <returns>
/// A new <see cref="Password"/> object containing the hashed password and a randomly generated salt.
/// </returns>
public static Password Pbkdf2(string password)
{ {
throw new NotImplementedException(); var salt = SecurityHelper.GetRandomBytes(saltSize);
var pwd = new Password(password, salt, Password.Pbkdf2Algorithm);
return pwd;
} }
/// <summary> Gets a cryptographically strong random password. </summary> /// <summary> Gets a cryptographically strong random password. </summary>
/// <param name="length"> The length of the password to generate. </param> /// <param name="length"> The length of the password to generate. </param>
/// <returns> The password. </returns> /// <returns> The password. </returns>
public static string GetRandomPassword(int length) public static string GetRandomPassword(int length, params ValidCharacterCollection[] validCharacters)
{ {
return GetRandomString(length); return GetRandomString(length, validCharacters);
}
/// <summary> Gets a calendar key that is <c>32</c> characters long. </summary>
/// <returns> The calendar key. </returns>
public static string GetCalendarKey()
{
return GetRandomString(32);
} }
/// <summary> Compares two session identifiers. </summary> /// <summary> Compares two session identifiers. </summary>
@ -119,25 +124,93 @@ namespace CapyKit.Helpers
return CompareStrings(first.Trim(), second.Trim()); return CompareStrings(first.Trim(), second.Trim());
} }
/// <summary>
/// A convenience method to generate a random string of the specified length using all character sets.
/// </summary>
/// <param name="length"> The desired length of the generated random string.</param>
/// <seealso cref="ValidCharacterCollection"/>
/// <seealso cref="GetRandomString(int, ValidCharacterCollection[])"/>
public static string GetRandomString(int length)
{
return GetRandomString(length,
ValidCharacterCollection.Lowercase,
ValidCharacterCollection.Uppercase,
ValidCharacterCollection.Numbers,
ValidCharacterCollection.Special);
}
/// <summary> Gets a cryptographically strong random string using the character values found in <see cref="VALID_CHARACTERS"/>. </summary> /// <summary> Gets a cryptographically strong random string using the character values found in <see cref="VALID_CHARACTERS"/>. </summary>
/// <param name="length"> The length of the string to create. </param> /// <param name="length"> The length of the string to create. </param>
/// <returns> The random string. </returns> /// <returns> The random string. </returns>
private static string GetRandomString(int length) public static string GetRandomString(int length, params ValidCharacterCollection[] validChars)
{ {
throw new NotImplementedException(); var buffer = new StringBuilder(length);
//var buffer = new StringBuilder(); var randomNumberBuffer = new byte[length * 3]; // Overprovision the buffer so we can discard a small percentage.
//while (buffer.Length < length) var validCharacters = GetValidCharacterComposition(validChars);
//{ var validByteUpperLimit = (256 / validCharacters.Length) * validCharacters.Length - 1; // Maintains equal distribution of valid characters.
// var oneByte = new byte[1];
// RandomNumberGenerator.GetBytes(oneByte);
// var character = (char)oneByte[0];
// if (VALID_CHARACTERS.Contains(character))
// {
// buffer.Append(character);
// }
//}
//return buffer.ToString(); using (var rng = RandomNumberGenerator.Create())
{
while (buffer.Length < length)
{
rng.GetBytes(randomNumberBuffer);
foreach (byte b in randomNumberBuffer)
{
if (b <= validByteUpperLimit)
{
int index = b % validCharacters.Length;
buffer.Append(validCharacters[index]);
if (buffer.Length == length)
{
break;
}
}
}
}
}
return buffer.ToString();
}
/// <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)
{
var buffer = new byte[length];
using (var rng = RandomNumberGenerator.Create())
{
rng.GetBytes(buffer);
}
return buffer;
}
private static string GetValidCharacterComposition(params ValidCharacterCollection[] validCharacters)
{
var composition = new StringBuilder();
foreach (var c in validCharacters)
{
switch (c)
{
case ValidCharacterCollection.Lowercase:
composition.Append(LOWER_CASE_CHARACTERS);
break;
case ValidCharacterCollection.Uppercase:
composition.Append(LOWER_CASE_CHARACTERS);
break;
case ValidCharacterCollection.Numbers:
composition.Append(LOWER_CASE_CHARACTERS);
break;
case ValidCharacterCollection.Special:
composition.Append(LOWER_CASE_CHARACTERS);
break;
default:
break;
}
}
return composition.ToString();
} }
/// <summary> Compare two strings as case sensative. </summary> /// <summary> Compare two strings as case sensative. </summary>
@ -158,4 +231,31 @@ namespace CapyKit.Helpers
#endregion Methods #endregion Methods
} }
/// <summary>
/// An enumeration that defines the types of characters that can be included in a random string.
/// </summary>
public enum ValidCharacterCollection
{
/// <summary>
/// Indicates that lower case characters should be included in the random string.
/// </summary>
[EnumerationDescriptionAttribute(SecurityHelper.LOWER_CASE_CHARACTERS)]
Lowercase,
/// <summary>
/// Indicates that upper case characters should be included in the random string.
/// </summary>
[EnumerationDescriptionAttribute(SecurityHelper.UPPER_CASE_CHARACTERS)]
Uppercase,
/// <summary>
/// Indicates that numeric characters should be included in the random string.
/// </summary>
[EnumerationDescriptionAttribute(SecurityHelper.NUMBER_CHARACTERS)]
Numbers,
/// <summary>
/// Indicates that special characters should be included in the random string.
/// </summary>
[EnumerationDescriptionAttribute(SecurityHelper.SPECIAL_CHARACTERS)]
Special,
}
} }

10
CapyKit/Password.cs
View file

@ -16,7 +16,7 @@ namespace CapyKit
{ {
#region Members #region Members
// private static Lazy<Pbkdf2Algorithm> algorithm = new Lazy<Pbkdf2Algorithm>(() => new Pbkdf2Algorithm());
#endregion #endregion
@ -37,6 +37,14 @@ namespace CapyKit
/// </summary> /// </summary>
public IPasswordAlgorithm Algorithm { get; private set; } public IPasswordAlgorithm Algorithm { get; private set; }
public static Pbkdf2Algorithm Pbkdf2Algorithm
{
get
{
return algorithm.Value;
}
}
#endregion #endregion
/// <summary> Constructor. </summary> /// <summary> Constructor. </summary>

2
Documentation/Documentation.shfbproj
View file

@ -31,7 +31,7 @@
<Argument Key="maxVersionParts" Value="" xmlns="" /> <Argument Key="maxVersionParts" Value="" xmlns="" />
</TransformComponentArguments> </TransformComponentArguments>
<HelpFileFormat>Markdown</HelpFileFormat> <HelpFileFormat>Markdown</HelpFileFormat>
<SyntaxFilters>Standard</SyntaxFilters> <SyntaxFilters>C#, F#</SyntaxFilters>
<PresentationStyle>Markdown</PresentationStyle> <PresentationStyle>Markdown</PresentationStyle>
<CleanIntermediates>True</CleanIntermediates> <CleanIntermediates>True</CleanIntermediates>
<KeepLogFile>True</KeepLogFile> <KeepLogFile>True</KeepLogFile>

11
Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md
View file

@ -7,21 +7,12 @@ The default number of iterations.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public const int ITERATIONS = 100000 public const int ITERATIONS = 100000
``` ```
**VB**
``` VB
Public Const ITERATIONS As Integer = 100000
```
**C++**
``` C++
public:
literal int ITERATIONS = 100000
```
**F#** **F#**
``` F# ``` F#
static val mutable ITERATIONS: int static val mutable ITERATIONS: int

11
Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md
View file

@ -7,21 +7,12 @@
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public const int LENGTH = 32 public const int LENGTH = 32
``` ```
**VB**
``` VB
Public Const LENGTH As Integer = 32
```
**C++**
``` C++
public:
literal int LENGTH = 32
```
**F#** **F#**
``` F# ``` F#
static val mutable LENGTH: int static val mutable LENGTH: int

15
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 ## Definition
**Namespace:** <a href="N_CapyKit_Attributes">CapyKit.Attributes</a> **Namespace:** <a href="N_CapyKit_Attributes">CapyKit.Attributes</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ protected EnumerationAttribute(
T value T value
) )
``` ```
**VB**
``` VB
Protected Sub New (
value As T
)
```
**C++**
``` C++
protected:
EnumerationAttribute(
T value
)
```
**F#** **F#**
``` F# ``` F#
new : new :

15
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 ## Definition
**Namespace:** <a href="N_CapyKit_Attributes">CapyKit.Attributes</a> **Namespace:** <a href="N_CapyKit_Attributes">CapyKit.Attributes</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public EnumerationDescriptionAttribute(
string description string description
) )
``` ```
**VB**
``` VB
Public Sub New (
description As String
)
```
**C++**
``` C++
public:
EnumerationDescriptionAttribute(
String^ description
)
```
**F#** **F#**
``` F# ``` F#
new : new :

19
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 ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -17,23 +17,6 @@ public CapyEventArgs(
string method = null string method = null
) )
``` ```
**VB**
``` VB
Public Sub New (
level As EventLevel,
message As String,
Optional method As String = Nothing
)
```
**C++**
``` C++
public:
CapyEventArgs(
EventLevel level,
String^ message,
String^ method = nullptr
)
```
**F#** **F#**
``` F# ``` F#
new : new :

19
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 ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -17,23 +17,6 @@ public static void Subscribe(
string origin = null string origin = null
) )
``` ```
**VB**
``` VB
Public Shared Sub Subscribe (
callback As CapyEventHandler,
subscriptionLevel As EventLevel,
Optional origin As String = Nothing
)
```
**C++**
``` C++
public:
static void Subscribe(
CapyEventHandler^ callback,
EventLevel subscriptionLevel,
String^ origin = nullptr
)
```
**F#** **F#**
``` F# ``` F#
static member Subscribe : static member Subscribe :

17
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 ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,21 +16,6 @@ public static void Unsubscribe(
string origin string origin
) )
``` ```
**VB**
``` VB
Public Shared Sub Unsubscribe (
callback As CapyEventHandler,
origin As String
)
```
**C++**
``` C++
public:
static void Unsubscribe(
CapyEventHandler^ callback,
String^ origin
)
```
**F#** **F#**
``` F# ``` F#
static member Unsubscribe : static member Unsubscribe :

17
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,21 +15,6 @@ public static string GetDescription(
this Enum enumeration this Enum enumeration
) )
``` ```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function GetDescription (
enumeration As Enum
) As String
```
**C++**
``` C++
public:
[ExtensionAttribute]
static String^ GetDescription(
Enum^ enumeration
)
```
**F#** **F#**
``` F# ``` F#
[<ExtensionAttribute>] [<ExtensionAttribute>]

17
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,21 +15,6 @@ public static string GetName(
this Enum enumeration this Enum enumeration
) )
``` ```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function GetName (
enumeration As Enum
) As String
```
**C++**
``` C++
public:
[ExtensionAttribute]
static String^ GetName(
Enum^ enumeration
)
```
**F#** **F#**
``` F# ``` F#
[<ExtensionAttribute>] [<ExtensionAttribute>]

17
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,21 +15,6 @@ public static string GetPrettyName(
this Enum enumeration this Enum enumeration
) )
``` ```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function GetPrettyName (
enumeration As Enum
) As String
```
**C++**
``` C++
public:
[ExtensionAttribute]
static String^ GetPrettyName(
Enum^ enumeration
)
```
**F#** **F#**
``` F# ``` F#
[<ExtensionAttribute>] [<ExtensionAttribute>]

17
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,21 +15,6 @@ public static int GetValue(
this Enum enumeration this Enum enumeration
) )
``` ```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function GetValue (
enumeration As Enum
) As Integer
```
**C++**
``` C++
public:
[ExtensionAttribute]
static int GetValue(
Enum^ enumeration
)
```
**F#** **F#**
``` F# ``` F#
[<ExtensionAttribute>] [<ExtensionAttribute>]

21
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -17,25 +17,6 @@ public static T Parse<T>(
) )
where T : Enum where T : Enum
```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function Parse(Of T As Enum) (
enumeration As T,
value As String
) As T
```
**C++**
``` C++
public:
[ExtensionAttribute]
generic<typename T>
where T : Enum
static T Parse(
T enumeration,
String^ value
)
``` ```
**F#** **F#**
``` F# ``` F#

23
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -18,27 +18,6 @@ public static T Parse<T>(
) )
where T : Enum where T : Enum
```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function Parse(Of T As Enum) (
enumeration As T,
value As String,
ignoreCase As Boolean
) As T
```
**C++**
``` C++
public:
[ExtensionAttribute]
generic<typename T>
where T : Enum
static T Parse(
T enumeration,
String^ value,
bool ignoreCase
)
``` ```
**F#** **F#**
``` F# ``` F#

20
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,24 +16,6 @@ public static IEnumerable<T> Distinct<T, U>(
Func<T, U> property Func<T, U> property
) )
```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function Distinct(Of T, U) (
items As IEnumerable(Of T),
property As Func(Of T, U)
) As IEnumerable(Of T)
```
**C++**
``` C++
public:
[ExtensionAttribute]
generic<typename T, typename U>
static IEnumerable<T>^ Distinct(
IEnumerable<T>^ items,
Func<T, U>^ property
)
``` ```
**F#** **F#**
``` F# ``` F#

20
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,24 +16,6 @@ public static IEnumerable<T> Filter<T>(
Func<T, bool> predicate Func<T, bool> predicate
) )
```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function Filter(Of T) (
source As IEnumerable(Of T),
predicate As Func(Of T, Boolean)
) As IEnumerable(Of T)
```
**C++**
``` C++
public:
[ExtensionAttribute]
generic<typename T>
static IEnumerable<T>^ Filter(
IEnumerable<T>^ source,
Func<T, bool>^ predicate
)
``` ```
**F#** **F#**
``` F# ``` F#

20
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,24 +16,6 @@ public static IQueryable<T> Filter<T>(
Expression<Func<T, bool>> predicate Expression<Func<T, bool>> predicate
) )
```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function Filter(Of T) (
source As IQueryable(Of T),
predicate As Expression(Of Func(Of T, Boolean))
) As IQueryable(Of T)
```
**C++**
``` C++
public:
[ExtensionAttribute]
generic<typename T>
static IQueryable<T>^ Filter(
IQueryable<T>^ source,
Expression<Func<T, bool>^>^ predicate
)
``` ```
**F#** **F#**
``` F# ``` F#

28
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -20,32 +20,6 @@ public static IEnumerable<R> LeftOuterJoin<T, U, TKey, R>(
Func<T, U> defaultGenerator = null Func<T, U> defaultGenerator = null
) )
```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function LeftOuterJoin(Of T, U, TKey, R) (
source As IEnumerable(Of T),
inner As IEnumerable(Of U),
outerSelector As Func(Of T, TKey),
innerSelector As Func(Of U, TKey),
resultSelector As Func(Of T, IEnumerable(Of U), R),
Optional defaultGenerator As Func(Of T, U) = Nothing
) As IEnumerable(Of R)
```
**C++**
``` C++
public:
[ExtensionAttribute]
generic<typename T, typename U, typename TKey, typename R>
static IEnumerable<R>^ LeftOuterJoin(
IEnumerable<T>^ source,
IEnumerable<U>^ inner,
Func<T, TKey>^ outerSelector,
Func<U, TKey>^ innerSelector,
Func<T, IEnumerable<U>^, R>^ resultSelector,
Func<T, U>^ defaultGenerator = nullptr
)
``` ```
**F#** **F#**
``` F# ``` F#

28
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -20,32 +20,6 @@ public static IQueryable<R> LeftOuterJoin<T, U, TKey, R>(
Func<T, U> defaultGenerator = null Func<T, U> defaultGenerator = null
) )
```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function LeftOuterJoin(Of T, U, TKey, R) (
source As IQueryable(Of T),
inner As IQueryable(Of U),
outerSelector As Expression(Of Func(Of T, TKey)),
innerSelector As Expression(Of Func(Of U, TKey)),
resultSelector As Func(Of T, IEnumerable(Of U), R),
Optional defaultGenerator As Func(Of T, U) = Nothing
) As IQueryable(Of R)
```
**C++**
``` C++
public:
[ExtensionAttribute]
generic<typename T, typename U, typename TKey, typename R>
static IQueryable<R>^ LeftOuterJoin(
IQueryable<T>^ source,
IQueryable<U>^ inner,
Expression<Func<T, TKey>^>^ outerSelector,
Expression<Func<U, TKey>^>^ innerSelector,
Func<T, IEnumerable<U>^, R>^ resultSelector,
Func<T, U>^ defaultGenerator = nullptr
)
``` ```
**F#** **F#**
``` F# ``` F#

20
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,24 +16,6 @@ public static int PageCount<T>(
int pageSize int pageSize
) )
```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function PageCount(Of T) (
source As IEnumerable(Of T),
pageSize As Integer
) As Integer
```
**C++**
``` C++
public:
[ExtensionAttribute]
generic<typename T>
static int PageCount(
IEnumerable<T>^ source,
int pageSize
)
``` ```
**F#** **F#**
``` F# ``` F#

20
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,24 +16,6 @@ public static int PageCount<T>(
int pageSize int pageSize
) )
```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function PageCount(Of T) (
source As IQueryable(Of T),
pageSize As Integer
) As Integer
```
**C++**
``` C++
public:
[ExtensionAttribute]
generic<typename T>
static int PageCount(
IQueryable<T>^ source,
int pageSize
)
``` ```
**F#** **F#**
``` F# ``` F#

22
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -17,26 +17,6 @@ public static IEnumerable<T> Page<T>(
int pageSize int pageSize
) )
```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function Page(Of T) (
source As IEnumerable(Of T),
pageNumber As Integer,
pageSize As Integer
) As IEnumerable(Of T)
```
**C++**
``` C++
public:
[ExtensionAttribute]
generic<typename T>
static IEnumerable<T>^ Page(
IEnumerable<T>^ source,
int pageNumber,
int pageSize
)
``` ```
**F#** **F#**
``` F# ``` F#

22
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -17,26 +17,6 @@ public static IQueryable<T> Page<T>(
int pageSize int pageSize
) )
```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function Page(Of T) (
source As IQueryable(Of T),
pageNumber As Integer,
pageSize As Integer
) As IQueryable(Of T)
```
**C++**
``` C++
public:
[ExtensionAttribute]
generic<typename T>
static IQueryable<T>^ Page(
IQueryable<T>^ source,
int pageNumber,
int pageSize
)
``` ```
**F#** **F#**
``` F# ``` F#

19
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,23 +16,6 @@ public static string IfNullOrEmpty(
string replacement string replacement
) )
``` ```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function IfNullOrEmpty (
value As String,
replacement As String
) As String
```
**C++**
``` C++
public:
[ExtensionAttribute]
static String^ IfNullOrEmpty(
String^ value,
String^ replacement
)
```
**F#** **F#**
``` F# ``` F#
[<ExtensionAttribute>] [<ExtensionAttribute>]

19
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 ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,23 +16,6 @@ public static string IfNullOrWhiteSpace(
string replacement string replacement
) )
``` ```
**VB**
``` VB
<ExtensionAttribute>
Public Shared Function IfNullOrWhiteSpace (
value As String,
replacement As String
) As String
```
**C++**
``` C++
public:
[ExtensionAttribute]
static String^ IfNullOrWhiteSpace(
String^ value,
String^ replacement
)
```
**F#** **F#**
``` F# ``` F#
[<ExtensionAttribute>] [<ExtensionAttribute>]

15
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md
View file

@ -7,7 +7,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">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public static byte[] Compress(
Object obj Object obj
) )
``` ```
**VB**
``` VB
Public Shared Function Compress (
obj As Object
) As Byte()
```
**C++**
``` C++
public:
static array<unsigned char>^ Compress(
Object^ obj
)
```
**F#** **F#**
``` F# ``` F#
static member Compress : static member Compress :

15
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 ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public static string CompressToString(
Object obj Object obj
) )
``` ```
**VB**
``` VB
Public Shared Function CompressToString (
obj As Object
) As String
```
**C++**
``` C++
public:
static String^ CompressToString(
Object^ obj
)
```
**F#** **F#**
``` F# ``` F#
static member CompressToString : static member CompressToString :

15
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md
View file

@ -7,7 +7,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">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public static string DecompressToString(
string compressed string compressed
) )
``` ```
**VB**
``` VB
Public Shared Function DecompressToString (
compressed As String
) As String
```
**C++**
``` C++
public:
static String^ DecompressToString(
String^ compressed
)
```
**F#** **F#**
``` F# ``` F#
static member DecompressToString : static member DecompressToString :

16
Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md
View file

@ -7,7 +7,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">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,20 +15,6 @@ public static T Decompress<T>(
byte[] byteStream byte[] byteStream
) )
```
**VB**
``` VB
Public Shared Function Decompress(Of T) (
byteStream As Byte()
) As T
```
**C++**
``` C++
public:
generic<typename T>
static T Decompress(
array<unsigned char>^ byteStream
)
``` ```
**F#** **F#**
``` F# ``` F#

16
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 ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,20 +15,6 @@ public static T Decompress<T>(
string encodedString string encodedString
) )
```
**VB**
``` VB
Public Shared Function Decompress(Of T) (
encodedString As String
) As T
```
**C++**
``` C++
public:
generic<typename T>
static T Decompress(
String^ encodedString
)
``` ```
**F#** **F#**
``` F# ``` F#

15
Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md
View file

@ -7,7 +7,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">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public static string CamelCaseToHumanReadable(
string value string value
) )
``` ```
**VB**
``` VB
Public Shared Function CamelCaseToHumanReadable (
value As String
) As String
```
**C++**
``` C++
public:
static String^ CamelCaseToHumanReadable(
String^ value
)
```
**F#** **F#**
``` F# ``` F#
static member CamelCaseToHumanReadable : static member CamelCaseToHumanReadable :

11
Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md
View file

@ -7,21 +7,12 @@ Initializes a new instance of the <a href="T_CapyKit_Helpers_LanguageHelper">Lan
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public LanguageHelper() public LanguageHelper()
``` ```
**VB**
``` VB
Public Sub New
```
**C++**
``` C++
public:
LanguageHelper()
```
**F#** **F#**
``` F# ``` F#
new : unit -> LanguageHelper new : unit -> LanguageHelper

17
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md
View file

@ -7,7 +7,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">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,21 +16,6 @@ public static bool CompareHashedPassword(
string existingPassword string existingPassword
) )
``` ```
**VB**
``` VB
Public Shared Function CompareHashedPassword (
providedPassword As String,
existingPassword As String
) As Boolean
```
**C++**
``` C++
public:
static bool CompareHashedPassword(
String^ providedPassword,
String^ existingPassword
)
```
**F#** **F#**
``` F# ``` F#
static member CompareHashedPassword : static member CompareHashedPassword :

17
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md
View file

@ -7,7 +7,7 @@ Compares two session identifiers.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,21 +16,6 @@ public static bool CompareSessionID(
string second string second
) )
``` ```
**VB**
``` VB
Public Shared Function CompareSessionID (
first As String,
second As String
) As Boolean
```
**C++**
``` C++
public:
static bool CompareSessionID(
String^ first,
String^ second
)
```
**F#** **F#**
``` F# ``` F#
static member CompareSessionID : static member CompareSessionID :

41
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetCalendarKey.md
View file

@ -1,41 +0,0 @@
# GetCalendarKey Method
Gets a calendar key that is `32` characters long.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d
**C#**
``` C#
public static string GetCalendarKey()
```
**VB**
``` VB
Public Shared Function GetCalendarKey As String
```
**C++**
``` C++
public:
static String^ GetCalendarKey()
```
**F#**
``` F#
static member GetCalendarKey : unit -> string
```
#### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
The calendar key.
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>

23
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md
View file

@ -7,37 +7,26 @@ Gets a cryptographically strong random password.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public static string GetRandomPassword( public static string GetRandomPassword(
int length int length,
) params ValidCharacterCollection[] validCharacters
```
**VB**
``` VB
Public Shared Function GetRandomPassword (
length As Integer
) As String
```
**C++**
``` C++
public:
static String^ GetRandomPassword(
int length
) )
``` ```
**F#** **F#**
``` F# ``` F#
static member GetRandomPassword : static member GetRandomPassword :
length : int -> string length : int *
validCharacters : ValidCharacterCollection[] -> string
``` ```
#### 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></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">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>

41
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md Normal file
View file

@ -0,0 +1,41 @@
# GetRandomString(Int32) Method
A convenience method to generate a random string of the specified length using all character sets.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
public static string GetRandomString(
int length
)
```
**F#**
``` F#
static member GetRandomString :
length : int -> string
```
#### 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 random string.</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.GetRandomString(System.Int32)"\]
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a>
<a href="Overload_CapyKit_Helpers_SecurityHelper_GetRandomString">GetRandomString Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>
<a href="T_CapyKit_Helpers_ValidCharacterCollection">ValidCharacterCollection</a>
<a href="M_CapyKit_Helpers_SecurityHelper_GetRandomString_1">GetRandomString(Int32, ValidCharacterCollection[])</a>

41
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md Normal file
View file

@ -0,0 +1,41 @@
# GetRandomString(Int32, ValidCharacterCollection[]) Method
Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS].
## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
public static string GetRandomString(
int length,
params ValidCharacterCollection[] validChars
)
```
**F#**
``` F#
static member GetRandomString :
length : int *
validChars : ValidCharacterCollection[] -> string
```
#### 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>
#### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
The random string.
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a>
<a href="Overload_CapyKit_Helpers_SecurityHelper_GetRandomString">GetRandomString Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>

15
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md
View file

@ -7,7 +7,7 @@ Hashes an unencrypted password.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public static string HashPassword(
string password string password
) )
``` ```
**VB**
``` VB
Public Shared Function HashPassword (
password As String
) As String
```
**C++**
``` C++
public:
static String^ HashPassword(
String^ password
)
```
**F#** **F#**
``` F# ``` F#
static member HashPassword : static member HashPassword :

39
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md
View file

@ -1,55 +1,42 @@
# Pbkdf2 Method # Pbkdf2(String) Method
\[Missing &lt;summary&gt; documentation for "M:CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[]@)"\] 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.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public static string Pbkdf2( public static Password Pbkdf2(
string password, string password
out byte[] salt
)
```
**VB**
``` VB
Public Shared Function Pbkdf2 (
password As String,
<OutAttribute> ByRef salt As Byte()
) As String
```
**C++**
``` C++
public:
static String^ Pbkdf2(
String^ password,
[OutAttribute] array<unsigned char>^% salt
) )
``` ```
**F#** **F#**
``` F# ``` F#
static member Pbkdf2 : static member Pbkdf2 :
password : string * password : string -> Password
salt : byte[] byref -> string
``` ```
#### Parameters #### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>\[Missing &lt;param name="password"/&gt; documentation for "M:CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[]@)"\]</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]</dt><dd>\[Missing &lt;param name="salt"/&gt; documentation for "M:CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[]@)"\]</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="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a> <a href="T_CapyKit_Password">Password</a>
\[Missing &lt;returns&gt; documentation for "M:CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[]@)"\] A new <a href="T_CapyKit_Password">Password</a> object containing the hashed password and a randomly generated salt.
## 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.
## See Also ## See Also
#### Reference #### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a> <a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a>
<a href="Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2">Pbkdf2 Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a> <a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>

44
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md Normal file
View file

@ -0,0 +1,44 @@
# 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*.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
public static Password Pbkdf2(
string password,
byte[] salt
)
```
**F#**
``` F#
static member Pbkdf2 :
password : string *
salt : byte[] -> Password
```
#### Parameters
<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
<a href="T_CapyKit_Password">Password</a>
A new <a href="T_CapyKit_Password">Password</a> object containing the hashed password and salt.
## 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.
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a>
<a href="Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2">Pbkdf2 Overload</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>

51
Documentation/Help/M_CapyKit_Helpers_SecurityHelper_SHA256Hash.md
View file

@ -1,51 +0,0 @@
# SHA256Hash Method
Produces a <a href="https://en.wikipedia.org/wiki/SHA-2">SHA256</a> hash from a given *value*.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d
**C#**
``` C#
public static byte[] SHA256Hash(
string value
)
```
**VB**
``` VB
Public Shared Function SHA256Hash (
value As String
) As Byte()
```
**C++**
``` C++
public:
static array<unsigned char>^ SHA256Hash(
String^ value
)
```
**F#**
``` F#
static member SHA256Hash :
value : string -> byte[]
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The value.</dd></dl>
#### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]
A byte array equal to the SHA256 hash of *value* or an empty array if it fails.
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>

11
Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md
View file

@ -7,21 +7,12 @@ Initializes a new instance of the <a href="T_CapyKit_Helpers_SecurityHelper">Sec
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public SecurityHelper() public SecurityHelper()
``` ```
**VB**
``` VB
Public Sub New
```
**C++**
``` C++
public:
SecurityHelper()
```
**F#** **F#**
``` F# ``` F#
new : unit -> SecurityHelper new : unit -> SecurityHelper

16
Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md
View file

@ -7,7 +7,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">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,20 +15,6 @@ public static T Deserialize<T>(
byte[] bytes byte[] bytes
) )
```
**VB**
``` VB
Public Shared Function Deserialize(Of T) (
bytes As Byte()
) As T
```
**C++**
``` C++
public:
generic<typename T>
static T Deserialize(
array<unsigned char>^ bytes
)
``` ```
**F#** **F#**
``` F# ``` F#

16
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 ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,20 +15,6 @@ public static T Deserialize<T>(
Stream stream Stream stream
) )
```
**VB**
``` VB
Public Shared Function Deserialize(Of T) (
stream As Stream
) As T
```
**C++**
``` C++
public:
generic<typename T>
static T Deserialize(
Stream^ stream
)
``` ```
**F#** **F#**
``` F# ``` F#

16
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 ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,20 +15,6 @@ public static T Deserialize<T>(
string str string str
) )
```
**VB**
``` VB
Public Shared Function Deserialize(Of T) (
str As String
) As T
```
**C++**
``` C++
public:
generic<typename T>
static T Deserialize(
String^ str
)
``` ```
**F#** **F#**
``` F# ``` F#

15
Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md
View file

@ -7,7 +7,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">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public static byte[] SerializeToBytes(
Object obj Object obj
) )
``` ```
**VB**
``` VB
Public Shared Function SerializeToBytes (
obj As Object
) As Byte()
```
**C++**
``` C++
public:
static array<unsigned char>^ SerializeToBytes(
Object^ obj
)
```
**F#** **F#**
``` F# ``` F#
static member SerializeToBytes : static member SerializeToBytes :

15
Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md
View file

@ -7,7 +7,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">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public static string SerializeToString(
Object obj Object obj
) )
``` ```
**VB**
``` VB
Public Shared Function SerializeToString (
obj As Object
) As String
```
**C++**
``` C++
public:
static String^ SerializeToString(
Object^ obj
)
```
**F#** **F#**
``` F# ``` F#
static member SerializeToString : static member SerializeToString :

18
Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md
View file

@ -7,7 +7,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">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -17,22 +17,6 @@ bool Compare(
params Object[] args params Object[] args
) )
``` ```
**VB**
``` VB
Function Compare (
password As String,
encryptedValue As Byte(),
ParamArray args As Object()
) As Boolean
```
**C++**
``` C++
bool Compare(
String^ password,
array<unsigned char>^ encryptedValue,
... array<Object^>^ args
)
```
**F#** **F#**
``` F# ``` F#
abstract Compare : abstract Compare :

16
Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md
View file

@ -7,7 +7,7 @@ Encrypts the given password using a defined algorithm.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,20 +16,6 @@ byte[] Encrypt(
params Object[] args params Object[] args
) )
``` ```
**VB**
``` VB
Function Encrypt (
password As String,
ParamArray args As Object()
) As Byte()
```
**C++**
``` C++
array<unsigned char>^ Encrypt(
String^ password,
... array<Object^>^ args
)
```
**F#** **F#**
``` F# ``` F#
abstract Encrypt : abstract Encrypt :

11
Documentation/Help/M_CapyKit_Password_ToString.md
View file

@ -7,21 +7,12 @@ Returns a string that represents the current object.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public override string ToString() public override string ToString()
``` ```
**VB**
``` VB
Public Overrides Function ToString As String
```
**C++**
``` C++
public:
virtual String^ ToString() override
```
**F#** **F#**
``` F# ``` F#
abstract ToString : unit -> string abstract ToString : unit -> string

17
Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md
View file

@ -7,7 +7,7 @@ Encrypts the given password using a PBKDF2 algorithm.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,21 +16,6 @@ public byte[] Encrypt(
params Object[] args params Object[] args
) )
``` ```
**VB**
``` VB
Public Function Encrypt (
password As String,
ParamArray args As Object()
) As Byte()
```
**C++**
``` C++
public:
virtual array<unsigned char>^ Encrypt(
String^ password,
... array<Object^>^ args
) sealed
```
**F#** **F#**
``` F# ``` F#
abstract Encrypt : abstract Encrypt :

11
Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md
View file

@ -7,21 +7,12 @@ Initializes a new instance of the <a href="T_CapyKit_Pbkdf2Algorithm">Pbkdf2Algo
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public Pbkdf2Algorithm() public Pbkdf2Algorithm()
``` ```
**VB**
``` VB
Public Sub New
```
**C++**
``` C++
public:
Pbkdf2Algorithm()
```
**F#** **F#**
``` F# ``` F#
new : unit -> Pbkdf2Algorithm new : unit -> Pbkdf2Algorithm

11
Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md
View file

@ -7,21 +7,12 @@ Releases the lock on the item.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public void ReleaseLock() public void ReleaseLock()
``` ```
**VB**
``` VB
Public Sub ReleaseLock
```
**C++**
``` C++
public:
void ReleaseLock()
```
**F#** **F#**
``` F# ``` F#
member ReleaseLock : unit -> unit member ReleaseLock : unit -> unit

11
Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md
View file

@ -7,21 +7,12 @@ 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">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public bool SetLock() public bool SetLock()
``` ```
**VB**
``` VB
Public Function SetLock As Boolean
```
**C++**
``` C++
public:
bool SetLock()
```
**F#** **F#**
``` F# ``` F#
member SetLock : unit -> bool member SetLock : unit -> bool

11
Documentation/Help/M_CapyKit_PoolItem_1_ToString.md
View file

@ -7,21 +7,12 @@ 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">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public override string ToString() public override string ToString()
``` ```
**VB**
``` VB
Public Overrides Function ToString As String
```
**C++**
``` C++
public:
virtual String^ ToString() override
```
**F#** **F#**
``` F# ``` F#
abstract ToString : unit -> string abstract ToString : unit -> string

11
Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md
View file

@ -7,21 +7,12 @@ 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">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public PoolItem<T> GetAvailableItem() public PoolItem<T> GetAvailableItem()
``` ```
**VB**
``` VB
Public Function GetAvailableItem As PoolItem(Of T)
```
**C++**
``` C++
public:
PoolItem<T>^ GetAvailableItem()
```
**F#** **F#**
``` F# ``` F#
member GetAvailableItem : unit -> PoolItem<'T> member GetAvailableItem : unit -> PoolItem<'T>

15
Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md
View file

@ -7,7 +7,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">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public void ReleaseItem(
PoolItem<T> item PoolItem<T> item
) )
``` ```
**VB**
``` VB
Public Sub ReleaseItem (
item As PoolItem(Of T)
)
```
**C++**
``` C++
public:
void ReleaseItem(
PoolItem<T>^ item
)
```
**F#** **F#**
``` F# ``` F#
member ReleaseItem : member ReleaseItem :

15
Documentation/Help/M_CapyKit_Pool_1__ctor.md
View file

@ -7,7 +7,7 @@ Initializes a new instance of the <a href="T_CapyKit_Pool_1">Pool(T)</a> class w
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public Pool(
IEnumerable<T> collection IEnumerable<T> collection
) )
``` ```
**VB**
``` VB
Public Sub New (
collection As IEnumerable(Of T)
)
```
**C++**
``` C++
public:
Pool(
IEnumerable<T>^ collection
)
```
**F#** **F#**
``` F# ``` F#
new : new :

15
Documentation/Help/M_CapyKit_Pool_1__ctor_1.md
View file

@ -7,7 +7,7 @@ Initializes a new instance of the <a href="T_CapyKit_Pool_1">Pool(T)</a> class w
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public Pool(
int poolSize int poolSize
) )
``` ```
**VB**
``` VB
Public Sub New (
poolSize As Integer
)
```
**C++**
``` C++
public:
Pool(
int poolSize
)
```
**F#** **F#**
``` F# ``` F#
new : new :

17
Documentation/Help/M_CapyKit_Pool_1__ctor_2.md
View file

@ -7,7 +7,7 @@ Initializes a new instance of the <a href="T_CapyKit_Pool_1">Pool(T)</a> class w
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,21 +16,6 @@ public Pool(
Func<T> constructorSelector Func<T> constructorSelector
) )
``` ```
**VB**
``` VB
Public Sub New (
poolSize As Integer,
constructorSelector As Func(Of T)
)
```
**C++**
``` C++
public:
Pool(
int poolSize,
Func<T>^ constructorSelector
)
```
**F#** **F#**
``` F# ``` F#
new : new :

17
Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md
View file

@ -7,7 +7,7 @@ Determines whether the specified properties are equal.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -16,21 +16,6 @@ public bool Equals(
T y T y
) )
``` ```
**VB**
``` VB
Public Function Equals (
x As T,
y As T
) As Boolean
```
**C++**
``` C++
public:
virtual bool Equals(
T x,
T y
) sealed
```
**F#** **F#**
``` F# ``` F#
abstract Equals : abstract Equals :

15
Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md
View file

@ -7,7 +7,7 @@ Returns a hash code for the specified object.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public int GetHashCode(
T obj T obj
) )
``` ```
**VB**
``` VB
Public Function GetHashCode (
obj As T
) As Integer
```
**C++**
``` C++
public:
virtual int GetHashCode(
T obj
) sealed
```
**F#** **F#**
``` F# ``` F#
abstract GetHashCode : abstract GetHashCode :

15
Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md
View file

@ -7,7 +7,7 @@ Constructor.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,19 +15,6 @@ public PropertyComparer(
Func<T, U> expression Func<T, U> expression
) )
``` ```
**VB**
``` VB
Public Sub New (
expression As Func(Of T, U)
)
```
**C++**
``` C++
public:
PropertyComparer(
Func<T, U>^ expression
)
```
**F#** **F#**
``` F# ``` F#
new : new :

17
Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md
View file

@ -18,15 +18,18 @@
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.finalize" target="_blank" rel="noopener noreferrer">Finalize</a></td> <td><a href="https://learn.microsoft.com/dotnet/api/system.object.finalize" target="_blank" rel="noopener noreferrer">Finalize</a></td>
<td>Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr> <td>Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
<tr> <tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetCalendarKey">GetCalendarKey</a></td>
<td>Gets a calendar key that is <code>32</code> characters long.</td></tr>
<tr>
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode" target="_blank" rel="noopener noreferrer">GetHashCode</a></td> <td><a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode" target="_blank" rel="noopener noreferrer">GetHashCode</a></td>
<td>Serves as the default hash function.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr> <td>Serves as the default hash function.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
<tr> <tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetRandomPassword">GetRandomPassword</a></td> <td><a href="M_CapyKit_Helpers_SecurityHelper_GetRandomPassword">GetRandomPassword</a></td>
<td>Gets a cryptographically strong random password.</td></tr> <td>Gets a cryptographically strong random password.</td></tr>
<tr> <tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetRandomString">GetRandomString(Int32)</a></td>
<td>A convenience method to generate a random string of the specified length using all character sets.</td></tr>
<tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetRandomString_1">GetRandomString(Int32, ValidCharacterCollection[])</a></td>
<td>Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS].</td></tr>
<tr>
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype" target="_blank" rel="noopener noreferrer">GetType</a></td> <td><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype" target="_blank" rel="noopener noreferrer">GetType</a></td>
<td>Gets the <a href="https://learn.microsoft.com/dotnet/api/system.type" target="_blank" rel="noopener noreferrer">Type</a> of the current instance.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr> <td>Gets the <a href="https://learn.microsoft.com/dotnet/api/system.type" target="_blank" rel="noopener noreferrer">Type</a> of the current instance.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
<tr> <tr>
@ -36,11 +39,11 @@
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone" target="_blank" rel="noopener noreferrer">MemberwiseClone</a></td> <td><a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone" target="_blank" rel="noopener noreferrer">MemberwiseClone</a></td>
<td>Creates a shallow copy of the current <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr> <td>Creates a shallow copy of the current <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
<tr> <tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_Pbkdf2">Pbkdf2</a></td> <td><a href="M_CapyKit_Helpers_SecurityHelper_Pbkdf2">Pbkdf2(String)</a></td>
<td> </td></tr> <td>Generates a new <a href="T_CapyKit_Password">Password</a> object using the PBKDF2 algorithm with the provided <em>password</em>. This overload of the method generates a random salt value for added security.</td></tr>
<tr> <tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_SHA256Hash">SHA256Hash</a></td> <td><a href="M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1">Pbkdf2(String, Byte[])</a></td>
<td>Produces a <a href="https://en.wikipedia.org/wiki/SHA-2">SHA256</a> hash from a given <em>value</em>.</td></tr> <td>Generates a new <a href="T_CapyKit_Password">Password</a> object using the PBKDF2 algorithm with the provided <em>password</em> and <em>salt</em>.</td></tr>
<tr> <tr>
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.tostring" target="_blank" rel="noopener noreferrer">ToString</a></td> <td><a href="https://learn.microsoft.com/dotnet/api/system.object.tostring" target="_blank" rel="noopener noreferrer">ToString</a></td>
<td>Returns a string that represents the current object.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr> <td>Returns a string that represents the current object.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>

7
Documentation/Help/N_CapyKit_Helpers.md
View file

@ -20,3 +20,10 @@
<td><a href="T_CapyKit_Helpers_SerializationHelper">SerializationHelper</a></td> <td><a href="T_CapyKit_Helpers_SerializationHelper">SerializationHelper</a></td>
<td> </td></tr> <td> </td></tr>
</table> </table>
## Enumerations
<table>
<tr>
<td><a href="T_CapyKit_Helpers_ValidCharacterCollection">ValidCharacterCollection</a></td>
<td>An enumeration that defines the types of characters that can be included in a random string.</td></tr>
</table>

19
Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md Normal file
View file

@ -0,0 +1,19 @@
# GetRandomString Method
## Overload List
<table>
<tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetRandomString">GetRandomString(Int32)</a></td>
<td>A convenience method to generate a random string of the specified length using all character sets.</td></tr>
<tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetRandomString_1">GetRandomString(Int32, ValidCharacterCollection[])</a></td>
<td>Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS].</td></tr>
</table>
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>

19
Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md Normal file
View file

@ -0,0 +1,19 @@
# Pbkdf2 Method
## Overload List
<table>
<tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_Pbkdf2">Pbkdf2(String)</a></td>
<td>Generates a new <a href="T_CapyKit_Password">Password</a> object using the PBKDF2 algorithm with the provided <em>password</em>. This overload of the method generates a random salt value for added security.</td></tr>
<tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1">Pbkdf2(String, Byte[])</a></td>
<td>Generates a new <a href="T_CapyKit_Password">Password</a> object using the PBKDF2 algorithm with the provided <em>password</em> and <em>salt</em>.</td></tr>
</table>
## See Also
#### Reference
<a href="T_CapyKit_Helpers_SecurityHelper">SecurityHelper Class</a>
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>

14
Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md
View file

@ -7,24 +7,12 @@ Initializes a new instance of the <a href="T_CapyKit_Attributes_EnumerationAttri
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Attributes">CapyKit.Attributes</a> **Namespace:** <a href="N_CapyKit_Attributes">CapyKit.Attributes</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public T Value { get; } public T Value { get; }
``` ```
**VB**
``` VB
Public ReadOnly Property Value As T
Get
```
**C++**
``` C++
public:
property T Value {
T get ();
}
```
**F#** **F#**
``` F# ``` F#
member Value : 'T with get member Value : 'T with get

14
Documentation/Help/P_CapyKit_CapyEventArgs_Level.md
View file

@ -7,24 +7,12 @@ Gets the severity level of the event.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public EventLevel Level { get; } public EventLevel Level { get; }
``` ```
**VB**
``` VB
Public ReadOnly Property Level As EventLevel
Get
```
**C++**
``` C++
public:
property EventLevel Level {
EventLevel get ();
}
```
**F#** **F#**
``` F# ``` F#
member Level : EventLevel with get member Level : EventLevel with get

14
Documentation/Help/P_CapyKit_CapyEventArgs_Message.md
View file

@ -7,24 +7,12 @@ Gets the message describing the reason for the event.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public string Message { get; } public string Message { get; }
``` ```
**VB**
``` VB
Public ReadOnly Property Message As String
Get
```
**C++**
``` C++
public:
property String^ Message {
String^ get ();
}
```
**F#** **F#**
``` F# ``` F#
member Message : string with get member Message : string with get

14
Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md
View file

@ -7,24 +7,12 @@ Gets the name of the method where the event was raised.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public string MethodName { get; } public string MethodName { get; }
``` ```
**VB**
``` VB
Public ReadOnly Property MethodName As String
Get
```
**C++**
``` C++
public:
property String^ MethodName {
String^ get ();
}
```
**F#** **F#**
``` F# ``` F#
member MethodName : string with get member MethodName : string with get

13
Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md
View file

@ -7,23 +7,12 @@ Gets the name of the algorithm.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
string AlgorithmName { get; } string AlgorithmName { get; }
``` ```
**VB**
``` VB
ReadOnly Property AlgorithmName As String
Get
```
**C++**
``` C++
property String^ AlgorithmName {
String^ get ();
}
```
**F#** **F#**
``` F# ``` F#
abstract AlgorithmName : string with get abstract AlgorithmName : string with get

14
Documentation/Help/P_CapyKit_Password_Algorithm.md
View file

@ -7,24 +7,12 @@ Gets or sets the algorithm used for password encryption.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public IPasswordAlgorithm Algorithm { get; } public IPasswordAlgorithm Algorithm { get; }
``` ```
**VB**
``` VB
Public ReadOnly Property Algorithm As IPasswordAlgorithm
Get
```
**C++**
``` C++
public:
property IPasswordAlgorithm^ Algorithm {
IPasswordAlgorithm^ get ();
}
```
**F#** **F#**
``` F# ``` F#
member Algorithm : IPasswordAlgorithm with get member Algorithm : IPasswordAlgorithm with get

14
Documentation/Help/P_CapyKit_Password_Hash.md
View file

@ -7,24 +7,12 @@ Gets or sets the hash of the password.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public byte[] Hash { get; } public byte[] Hash { get; }
``` ```
**VB**
``` VB
Public ReadOnly Property Hash As Byte()
Get
```
**C++**
``` C++
public:
property array<unsigned char>^ Hash {
array<unsigned char>^ get ();
}
```
**F#** **F#**
``` F# ``` F#
member Hash : byte[] with get member Hash : byte[] with get

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

@ -0,0 +1,31 @@
# Pbkdf2Algorithm Property
\[Missing &lt;summary&gt; documentation for "P:CapyKit.Password.Pbkdf2Algorithm"\]
## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
public static Pbkdf2Algorithm Pbkdf2Algorithm { get; }
```
**F#**
``` F#
static member Pbkdf2Algorithm : Pbkdf2Algorithm with get
```
#### Property Value
<a href="T_CapyKit_Pbkdf2Algorithm">Pbkdf2Algorithm</a>
## See Also
#### Reference
<a href="T_CapyKit_Password">Password Class</a>
<a href="N_CapyKit">CapyKit Namespace</a>

14
Documentation/Help/P_CapyKit_Password_Salt.md
View file

@ -7,24 +7,12 @@ Gets or sets the salt used for encryption.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public byte[] Salt { get; } public byte[] Salt { get; }
``` ```
**VB**
``` VB
Public ReadOnly Property Salt As Byte()
Get
```
**C++**
``` C++
public:
property array<unsigned char>^ Salt {
array<unsigned char>^ get ();
}
```
**F#** **F#**
``` F# ``` F#
member Salt : byte[] with get member Salt : byte[] with get

14
Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md
View file

@ -7,24 +7,12 @@ Gets the name of the algorithm.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public string AlgorithmName { get; } public string AlgorithmName { get; }
``` ```
**VB**
``` VB
Public ReadOnly Property AlgorithmName As String
Get
```
**C++**
``` C++
public:
virtual property String^ AlgorithmName {
String^ get () sealed;
}
```
**F#** **F#**
``` F# ``` F#
abstract AlgorithmName : string with get abstract AlgorithmName : string with get

14
Documentation/Help/P_CapyKit_PoolItem_1_Index.md
View file

@ -7,24 +7,12 @@ Gets the zero-based index of the pooled item.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public int Index { get; } public int Index { get; }
``` ```
**VB**
``` VB
Public ReadOnly Property Index As Integer
Get
```
**C++**
``` C++
public:
property int Index {
int get ();
}
```
**F#** **F#**
``` F# ``` F#
member Index : int with get member Index : int with get

14
Documentation/Help/P_CapyKit_PoolItem_1_Item.md
View file

@ -7,24 +7,12 @@ Gets the pooled resource.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public T Item { get; } public T Item { get; }
``` ```
**VB**
``` VB
Public ReadOnly Property Item As T
Get
```
**C++**
``` C++
public:
property T Item {
T get ();
}
```
**F#** **F#**
``` F# ``` F#
member Item : 'T with get member Item : 'T with get

14
Documentation/Help/P_CapyKit_PoolItem_1_Locked.md
View file

@ -7,24 +7,12 @@ Gets a value indicating whether this object is locked or not.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public bool Locked { get; } public bool Locked { get; }
``` ```
**VB**
``` VB
Public ReadOnly Property Locked As Boolean
Get
```
**C++**
``` C++
public:
property bool Locked {
bool get ();
}
```
**F#** **F#**
``` F# ``` F#
member Locked : bool with get member Locked : bool with get

14
Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md
View file

@ -7,24 +7,12 @@ Gets the name of the <a href="https://learn.microsoft.com/dotnet/api/system.type
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public string TypeName { get; } public string TypeName { get; }
``` ```
**VB**
``` VB
Public ReadOnly Property TypeName As String
Get
```
**C++**
``` C++
public:
property String^ TypeName {
String^ get ();
}
```
**F#** **F#**
``` F# ``` F#
member TypeName : string with get member TypeName : string with get

3
Documentation/Help/Properties_T_CapyKit_Password.md
View file

@ -12,6 +12,9 @@
<td><a href="P_CapyKit_Password_Hash">Hash</a></td> <td><a href="P_CapyKit_Password_Hash">Hash</a></td>
<td>Gets or sets the hash of the password.</td></tr> <td>Gets or sets the hash of the password.</td></tr>
<tr> <tr>
<td><a href="P_CapyKit_Password_Pbkdf2Algorithm">Pbkdf2Algorithm</a></td>
<td> </td></tr>
<tr>
<td><a href="P_CapyKit_Password_Salt">Salt</a></td> <td><a href="P_CapyKit_Password_Salt">Salt</a></td>
<td>Gets or sets the salt used for encryption.</td></tr> <td>Gets or sets the salt used for encryption.</td></tr>
</table> </table>

12
Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md
View file

@ -7,22 +7,12 @@ Custom attribute class for decorating enumeration fields with additional data.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Attributes">CapyKit.Attributes</a> **Namespace:** <a href="N_CapyKit_Attributes">CapyKit.Attributes</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public abstract class EnumerationAttribute<T> : Attribute public abstract class EnumerationAttribute<T> : Attribute
```
**VB**
``` VB
Public MustInherit Class EnumerationAttribute(Of T)
Inherits Attribute
```
**C++**
``` C++
generic<typename T>
public ref class EnumerationAttribute abstract : public Attribute
``` ```
**F#** **F#**
``` F# ``` F#

11
Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md
View file

@ -7,21 +7,12 @@ An attribute class for decorating enumeration fields with a description.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Attributes">CapyKit.Attributes</a> **Namespace:** <a href="N_CapyKit_Attributes">CapyKit.Attributes</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public class EnumerationDescriptionAttribute : EnumerationAttribute<string> public class EnumerationDescriptionAttribute : EnumerationAttribute<string>
``` ```
**VB**
``` VB
Public Class EnumerationDescriptionAttribute
Inherits EnumerationAttribute(Of String)
```
**C++**
``` C++
public ref class EnumerationDescriptionAttribute : public EnumerationAttribute<String^>
```
**F#** **F#**
``` F# ``` F#
type EnumerationDescriptionAttribute = type EnumerationDescriptionAttribute =

11
Documentation/Help/T_CapyKit_CapyEventArgs.md
View file

@ -7,21 +7,12 @@ The CapyEventArgs class represents an event argument instance with event level,
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public class CapyEventArgs : EventArgs public class CapyEventArgs : EventArgs
``` ```
**VB**
``` VB
Public Class CapyEventArgs
Inherits EventArgs
```
**C++**
``` C++
public ref class CapyEventArgs : public EventArgs
```
**F#** **F#**
``` F# ``` F#
type CapyEventArgs = type CapyEventArgs =

14
Documentation/Help/T_CapyKit_CapyEventHandler.md
View file

@ -7,7 +7,7 @@ A delegate representing an event handler that accepts a <a href="T_CapyKit_CapyE
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
@ -15,18 +15,6 @@ public delegate void CapyEventHandler(
CapyEventArgs e CapyEventArgs e
) )
``` ```
**VB**
``` VB
Public Delegate Sub CapyEventHandler (
e As CapyEventArgs
)
```
**C++**
``` C++
public delegate void CapyEventHandler(
CapyEventArgs^ e
)
```
**F#** **F#**
``` F# ``` F#
type CapyEventHandler = type CapyEventHandler =

10
Documentation/Help/T_CapyKit_CapyEventReporter.md
View file

@ -7,20 +7,12 @@ The CapyEventReporter class is responsible for managing event subscriptions and
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public static class CapyEventReporter public static class CapyEventReporter
``` ```
**VB**
``` VB
Public NotInheritable Class CapyEventReporter
```
**C++**
``` C++
public ref class CapyEventReporter abstract sealed
```
**F#** **F#**
``` F# ``` F#
[<AbstractClassAttribute>] [<AbstractClassAttribute>]

10
Documentation/Help/T_CapyKit_Color.md
View file

@ -7,20 +7,12 @@ Enum representing a set of named colors with their corresponding HEX values. The
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public enum Color public enum Color
``` ```
**VB**
``` VB
Public Enumeration Color
```
**C++**
``` C++
public enum class Color
```
**F#** **F#**
``` F# ``` F#
type Color type Color

10
Documentation/Help/T_CapyKit_EventLevel.md
View file

@ -7,20 +7,12 @@ Enumeration representing different event level severity values.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit">CapyKit</a> **Namespace:** <a href="N_CapyKit">CapyKit</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public enum EventLevel public enum EventLevel
``` ```
**VB**
``` VB
Public Enumeration EventLevel
```
**C++**
``` C++
public enum class EventLevel
```
**F#** **F#**
``` F# ``` F#
type EventLevel type EventLevel

12
Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md
View file

@ -7,22 +7,12 @@ Provides static extentions methods for providing additional functionality for <a
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public static class EnumerationExtensions public static class EnumerationExtensions
``` ```
**VB**
``` VB
<ExtensionAttribute>
Public NotInheritable Class EnumerationExtensions
```
**C++**
``` C++
[ExtensionAttribute]
public ref class EnumerationExtensions abstract sealed
```
**F#** **F#**
``` F# ``` F#
[<AbstractClassAttribute>] [<AbstractClassAttribute>]

12
Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md
View file

@ -7,22 +7,12 @@ Provides static extension methods for performing common LINQ operations on <a hr
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public static class LINQExtensions public static class LINQExtensions
``` ```
**VB**
``` VB
<ExtensionAttribute>
Public NotInheritable Class LINQExtensions
```
**C++**
``` C++
[ExtensionAttribute]
public ref class LINQExtensions abstract sealed
```
**F#** **F#**
``` F# ``` F#
[<AbstractClassAttribute>] [<AbstractClassAttribute>]

12
Documentation/Help/T_CapyKit_Extensions_StringExtensions.md
View file

@ -7,22 +7,12 @@ Provides static extentions methods for providing additional functionality for <a
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a> **Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public static class StringExtensions public static class StringExtensions
``` ```
**VB**
``` VB
<ExtensionAttribute>
Public NotInheritable Class StringExtensions
```
**C++**
``` C++
[ExtensionAttribute]
public ref class StringExtensions abstract sealed
```
**F#** **F#**
``` F# ``` F#
[<AbstractClassAttribute>] [<AbstractClassAttribute>]

10
Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md
View file

@ -7,20 +7,12 @@ A class that contains methods for managing data compression.
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public static class CompressionHelper public static class CompressionHelper
``` ```
**VB**
``` VB
Public NotInheritable Class CompressionHelper
```
**C++**
``` C++
public ref class CompressionHelper abstract sealed
```
**F#** **F#**
``` F# ``` F#
[<AbstractClassAttribute>] [<AbstractClassAttribute>]

10
Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md
View file

@ -7,20 +7,12 @@
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public class LanguageHelper public class LanguageHelper
``` ```
**VB**
``` VB
Public Class LanguageHelper
```
**C++**
``` C++
public ref class LanguageHelper
```
**F#** **F#**
``` F# ``` F#
type LanguageHelper = class end type LanguageHelper = class end

27
Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md
View file

@ -7,20 +7,12 @@ A class that contains methods for managing secure data processing and cryptograp
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public class SecurityHelper public class SecurityHelper
``` ```
**VB**
``` VB
Public Class SecurityHelper
```
**C++**
``` C++
public ref class SecurityHelper
```
**F#** **F#**
``` F# ``` F#
type SecurityHelper = class end type SecurityHelper = class end
@ -53,15 +45,18 @@ type SecurityHelper = class end
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.finalize" target="_blank" rel="noopener noreferrer">Finalize</a></td> <td><a href="https://learn.microsoft.com/dotnet/api/system.object.finalize" target="_blank" rel="noopener noreferrer">Finalize</a></td>
<td>Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr> <td>Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
<tr> <tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetCalendarKey">GetCalendarKey</a></td>
<td>Gets a calendar key that is <code>32</code> characters long.</td></tr>
<tr>
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode" target="_blank" rel="noopener noreferrer">GetHashCode</a></td> <td><a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode" target="_blank" rel="noopener noreferrer">GetHashCode</a></td>
<td>Serves as the default hash function.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr> <td>Serves as the default hash function.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
<tr> <tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetRandomPassword">GetRandomPassword</a></td> <td><a href="M_CapyKit_Helpers_SecurityHelper_GetRandomPassword">GetRandomPassword</a></td>
<td>Gets a cryptographically strong random password.</td></tr> <td>Gets a cryptographically strong random password.</td></tr>
<tr> <tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetRandomString">GetRandomString(Int32)</a></td>
<td>A convenience method to generate a random string of the specified length using all character sets.</td></tr>
<tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_GetRandomString_1">GetRandomString(Int32, ValidCharacterCollection[])</a></td>
<td>Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS].</td></tr>
<tr>
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype" target="_blank" rel="noopener noreferrer">GetType</a></td> <td><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype" target="_blank" rel="noopener noreferrer">GetType</a></td>
<td>Gets the <a href="https://learn.microsoft.com/dotnet/api/system.type" target="_blank" rel="noopener noreferrer">Type</a> of the current instance.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr> <td>Gets the <a href="https://learn.microsoft.com/dotnet/api/system.type" target="_blank" rel="noopener noreferrer">Type</a> of the current instance.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
<tr> <tr>
@ -71,11 +66,11 @@ type SecurityHelper = class end
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone" target="_blank" rel="noopener noreferrer">MemberwiseClone</a></td> <td><a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone" target="_blank" rel="noopener noreferrer">MemberwiseClone</a></td>
<td>Creates a shallow copy of the current <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr> <td>Creates a shallow copy of the current <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>
<tr> <tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_Pbkdf2">Pbkdf2</a></td> <td><a href="M_CapyKit_Helpers_SecurityHelper_Pbkdf2">Pbkdf2(String)</a></td>
<td> </td></tr> <td>Generates a new <a href="T_CapyKit_Password">Password</a> object using the PBKDF2 algorithm with the provided <em>password</em>. This overload of the method generates a random salt value for added security.</td></tr>
<tr> <tr>
<td><a href="M_CapyKit_Helpers_SecurityHelper_SHA256Hash">SHA256Hash</a></td> <td><a href="M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1">Pbkdf2(String, Byte[])</a></td>
<td>Produces a <a href="https://en.wikipedia.org/wiki/SHA-2">SHA256</a> hash from a given <em>value</em>.</td></tr> <td>Generates a new <a href="T_CapyKit_Password">Password</a> object using the PBKDF2 algorithm with the provided <em>password</em> and <em>salt</em>.</td></tr>
<tr> <tr>
<td><a href="https://learn.microsoft.com/dotnet/api/system.object.tostring" target="_blank" rel="noopener noreferrer">ToString</a></td> <td><a href="https://learn.microsoft.com/dotnet/api/system.object.tostring" target="_blank" rel="noopener noreferrer">ToString</a></td>
<td>Returns a string that represents the current object.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr> <td>Returns a string that represents the current object.<br />(Inherited from <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)</td></tr>

10
Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md
View file

@ -7,20 +7,12 @@
## Definition ## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a> **Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#** **C#**
``` C# ``` C#
public static class SerializationHelper public static class SerializationHelper
``` ```
**VB**
``` VB
Public NotInheritable Class SerializationHelper
```
**C++**
``` C++
public ref class SerializationHelper abstract sealed
```
**F#** **F#**
``` F# ``` F#
[<AbstractClassAttribute>] [<AbstractClassAttribute>]

47
Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md Normal file
View file

@ -0,0 +1,47 @@
# ValidCharacterCollection Enumeration
An enumeration that defines the types of characters that can be included in a random string.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
public enum ValidCharacterCollection
```
**F#**
``` F#
type ValidCharacterCollection
```
## Members
<table>
<tr>
<td>Lowercase</td>
<td>0</td>
<td>Indicates that lower case characters should be included in the random string.</td></tr>
<tr>
<td>Uppercase</td>
<td>1</td>
<td>Indicates that upper case characters should be included in the random string.</td></tr>
<tr>
<td>Numbers</td>
<td>2</td>
<td>Indicates that numeric characters should be included in the random string.</td></tr>
<tr>
<td>Special</td>
<td>3</td>
<td>Indicates that special characters should be included in the random string.</td></tr>
</table>
## See Also
#### Reference
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>

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