From 5e2acdb8b469712508b5d3c9a5f3097e6553f967 Mon Sep 17 00:00:00 2001
From: Eugene Fox <eugene@xfox111.net>
Date: Mon, 31 May 2021 01:17:04 +0300
Subject: [PATCH] Created OTPService.ValidateHotp (markdown)

---
 OTPService.ValidateHotp.md | 39 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 OTPService.ValidateHotp.md

diff --git a/OTPService.ValidateHotp.md b/OTPService.ValidateHotp.md
new file mode 100644
index 0000000..cb5e017
--- /dev/null
+++ b/OTPService.ValidateHotp.md
@@ -0,0 +1,39 @@
+Namespace: `SimpleOTP`
+
+Assembly: `SimpleOTP.dll`
+
+Validates provided HOTP code with provided parameters.
+```csharp
+public static bool ValidateHotp(int otp, ref OTPConfiguration target, int toleranceSpan, bool resyncCounter);
+```
+### Parameters
+`otp` `Int32`
+
+HOTP code to validate.
+
+`target` [OTPConfiguration](https://github.com/XFox111/SimpleOTP/wiki/OTPConfiguration)
+
+OTP configuration for check codes generation.
+
+`toleranceSpan` `Int32`
+
+Counter span from which OTP codes remain valid.
+
+`resyncCounter` `Boolean`
+
+Defines whether method should resync <see `OTPConfiguration.Counter` of the `target` or not after successful validation.
+### Returns
+`True` if code is valid, `False` if it isn't.
+
+### Exceptions
+[ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/system.ArgumentException?view=net-5.0)
+
+`target.Type` is `OTPType.TOTP`
+
+[NullReferenceException](https://docs.microsoft.com/en-us/dotnet/api/system.nullreferenceexception?view=net-5.0)
+
+`target` is `null`
+### Examples
+See `OTPService` usage examples on [Code generation/validation](https://github.com/XFox111/SimpleOTP/wiki/Code-generation-or-validation)
+### Remarks
+Use this method only with HOTP codes.
\ No newline at end of file