Generate API docs as markdown
This commit is contained in:
parent
ab7b83abbb
commit
85e90f7bd5
120 changed files with 14227 additions and 76482 deletions
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class KeyHelper | CapyKit Documentation </title>
|
||||
<title> Class KeyHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class KeyHelper | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class KeyHelper | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="A class that contains methods for managing key creation and validation against a master key.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,381 +70,105 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers.KeyHelper">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Helpers_KeyHelper" data-uid="CapyKit.Helpers.KeyHelper" class="text-break">
|
||||
Class KeyHelper
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A class that contains methods for managing key creation and validation against a master key.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class KeyHelper</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">KeyHelper</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_GenerateKey_" data-uid="CapyKit.Helpers.KeyHelper.GenerateKey*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GenerateKey" data-uid="CapyKit.Helpers.KeyHelper.GenerateKey">
|
||||
GenerateKey()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generates a random key.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string GenerateKey()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The key.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_GetMasterKey_" data-uid="CapyKit.Helpers.KeyHelper.GetMasterKey*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetMasterKey" data-uid="CapyKit.Helpers.KeyHelper.GetMasterKey">
|
||||
GetMasterKey()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the master key.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public byte[] GetMasterKey()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>An array of byte.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></dt>
|
||||
<dd><p>Thrown when the requested operation is invalid.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_GetNumParts_" data-uid="CapyKit.Helpers.KeyHelper.GetNumParts*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetNumParts" data-uid="CapyKit.Helpers.KeyHelper.GetNumParts">
|
||||
GetNumParts()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the number parts.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int GetNumParts()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The number parts.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></dt>
|
||||
<dd><p>Thrown when one or more arguments have unsupported or illegal values.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_GetSaltSize_" data-uid="CapyKit.Helpers.KeyHelper.GetSaltSize*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetSaltSize" data-uid="CapyKit.Helpers.KeyHelper.GetSaltSize">
|
||||
GetSaltSize()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the salt size.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int GetSaltSize()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The salt size.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_" data-uid="CapyKit.Helpers.KeyHelper.SetMasterKeyAccessor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____" data-uid="CapyKit.Helpers.KeyHelper.SetMasterKeyAccessor(System.Func{System.Byte[]})">
|
||||
SetMasterKeyAccessor(Func<byte[]>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets the master key.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetMasterKeyAccessor(Func<byte[]> accessor)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>accessor</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]></dt>
|
||||
<dd><p>The accessor function.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_SetNumPartsAccessor_" data-uid="CapyKit.Helpers.KeyHelper.SetNumPartsAccessor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetNumPartsAccessor_System_Func_System_Int32__" data-uid="CapyKit.Helpers.KeyHelper.SetNumPartsAccessor(System.Func{System.Int32})">
|
||||
SetNumPartsAccessor(Func<int>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Set and get the number of parts for the formatted key. Default is 2.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetNumPartsAccessor(Func<int> accessor)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>accessor</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></dt>
|
||||
<dd><p>The accessor function.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_SetSaltSizeAccessor_" data-uid="CapyKit.Helpers.KeyHelper.SetSaltSizeAccessor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetSaltSizeAccessor_System_Func_System_Int32__" data-uid="CapyKit.Helpers.KeyHelper.SetSaltSizeAccessor(System.Func{System.Int32})">
|
||||
SetSaltSizeAccessor(Func<int>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets the salt size (in bytes). Default is 4.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetSaltSizeAccessor(Func<int> accessor)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>accessor</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></dt>
|
||||
<dd><p>The accessor function.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_ValidateKey_" data-uid="CapyKit.Helpers.KeyHelper.ValidateKey*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_ValidateKey_System_String_" data-uid="CapyKit.Helpers.KeyHelper.ValidateKey(System.String)">
|
||||
ValidateKey(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Validates the provided key.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ValidateKey(string providedKey)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>providedKey</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The provided key.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>True if it succeeds, false if it fails.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist seealso">
|
||||
<dt>See Also</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="CapyKit.Helpers.KeyHelper.html#CapyKit_Helpers_KeyHelper_GetMasterKey">GetMasterKey()</a></div>
|
||||
<div><a class="xref" href="CapyKit.Helpers.KeyHelper.html#CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____">SetMasterKeyAccessor(Func<byte[]>)</a></div>
|
||||
<div><span class="xref">masterKeyAccessor</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers_KeyHelper"> Class KeyHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A class that contains methods for managing key creation and validation against a master key.</p>
|
||||
<pre><code class="lang-csharp">public class KeyHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<KeyHelper>(KeyHelper, KeyHelper)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GenerateKey"> GenerateKey()</h3>
|
||||
<p>Generates a random key.</p>
|
||||
<pre><code class="lang-csharp">public string GenerateKey()
|
||||
</code></pre>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The key.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetMasterKey"> GetMasterKey()</h3>
|
||||
<p>Gets the master key.</p>
|
||||
<pre><code class="lang-csharp">public byte[] GetMasterKey()
|
||||
</code></pre>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>An array of byte.</p>
|
||||
<h4 id="exceptions">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></p>
|
||||
<p>Thrown when the requested operation is invalid.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetNumParts"> GetNumParts()</h3>
|
||||
<p>Gets the number parts.</p>
|
||||
<pre><code class="lang-csharp">public int GetNumParts()
|
||||
</code></pre>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The number parts.</p>
|
||||
<h4 id="exceptions-1">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></p>
|
||||
<p>Thrown when one or more arguments have unsupported or illegal values.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetSaltSize"> GetSaltSize()</h3>
|
||||
<p>Gets the salt size.</p>
|
||||
<pre><code class="lang-csharp">public int GetSaltSize()
|
||||
</code></pre>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The salt size.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____"> SetMasterKeyAccessor(Func<byte[]>)</h3>
|
||||
<p>Sets the master key.</p>
|
||||
<pre><code class="lang-csharp">public void SetMasterKeyAccessor(Func<byte[]> accessor)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]></p>
|
||||
<p>The accessor function.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetNumPartsAccessor_System_Func_System_Int32__"> SetNumPartsAccessor(Func<int>)</h3>
|
||||
<p>Set and get the number of parts for the formatted key. Default is 2.</p>
|
||||
<pre><code class="lang-csharp">public void SetNumPartsAccessor(Func<int> accessor)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></p>
|
||||
<p>The accessor function.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetSaltSizeAccessor_System_Func_System_Int32__"> SetSaltSizeAccessor(Func<int>)</h3>
|
||||
<p>Sets the salt size (in bytes). Default is 4.</p>
|
||||
<pre><code class="lang-csharp">public void SetSaltSizeAccessor(Func<int> accessor)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></p>
|
||||
<p>The accessor function.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_ValidateKey_System_String_"> ValidateKey(string)</h3>
|
||||
<p>Validates the provided key.</p>
|
||||
<pre><code class="lang-csharp">public bool ValidateKey(string providedKey)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>providedKey</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The provided key.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p>True if it succeeds, false if it fails.</p>
|
||||
<h4 id="see-also">See Also</h4>
|
||||
<p><a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.<a href="CapyKit.Helpers.KeyHelper.html#CapyKit_Helpers_KeyHelper_GetMasterKey">GetMasterKey</a>(),
|
||||
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.<a href="CapyKit.Helpers.KeyHelper.html#CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____">SetMasterKeyAccessor</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]>),
|
||||
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.masterKeyAccessor</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue