Show / Hide Table of Contents

GetData Method

GetData()

Gets the temporary PIN if requested.

C#
public ReadOnlyMemory<byte> GetData()

Returns

ReadOnlyMemory<byte>

null if the PIN verifies, or the number of retries remaining if the PIN does not verify.

Implements

IYubiKeyResponseWithData<TData>.GetData()

Exceptions

Type Condition
InvalidOperationException

Thrown if Status is not Success or AuthenticationRequired.

Remarks

First look at the Status. If Status is not one of the following values then an error has occurred and GetData() will throw an exception.

StatusDescription
SuccessThe biometric authentication succeeded. If requested, GetData returns the temporary PIN.
AuthenticationRequiredThe biometric authentication did not succeed. AttemptsRemaining contains number of of retries remaining. If the number of retries is 0 the biometric authentication is blocked and the client should use PIN authentication (VerifyPinCommand).
In this article
Back to top Generated by DocFX