PIVReturnCodes (aijnipiv

All Known Implementing Classes:

PivApiWrapper
```
public interface PIVReturnCodes
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`PIV_AUTHENTICATION_FAILURE` Authentication failed.
`static int`	`PIV_AUTHENTICATOR_MALFORMED` The authenticator's data objects to be used by the `pivLogIntoCardApplication()` function do not conform to the expected data format (Table 10 of [SP 800-73]).
`static int`	`PIV_CARD_APPLICATION_NOT_FOUND` Application AID does not refer to an AID that the card supports.
`static int`	`PIV_CARD_READER_ERROR` An unexpected APDU response or an unexpected response from the PC/SC layer was received.
`static int`	`PIV_CONNECTION_DESCRIPTION_MALFORMED` The ConnectionDescription parameter in the function call does not conform to the required data format or the PC/SC returned one of the following error codes: SCARD_E_UNKNOWN_READER SCARD_E_DUPLICATE_READER
`static int`	`PIV_CONNECTION_FAILURE` There is no smart card in the reader or the smart card returned an unexpected answer or no answer at all or the PC/SC service is not started.
`static int`	`PIV_CONNECTION_LOCKED` A SCARD_E_SHARING_VIOLATION error was returned by PC/SC.
`static int`	`PIV_DATA_OBJECT_NOT_FOUND` Object requested does not exist on the card.
`static int`	`PIV_INPUT_BYTES_MALFORMED` Incorrect input data format (Table 17 of [SP 800-73]).
`static int`	`PIV_INSUFFICIENT_BUFFER` Specified output buffer too small.
`static int`	`PIV_INSUFFICIENT_CARD_RESOURCE` The card does not have enough resources to perform this operation with the given parameter values.
`static int`	`PIV_INVALID_CARD_HANDLE` The communication handle is invalid.
`static int`	`PIV_INVALID_KEY_OR_KEYALG_COMBINATION` Inconsistency in `pivGenerateKeyPair()` input parameters.
`static int`	`PIV_INVALID_KEYREF_OR_ALGORITHM` Unsupported key reference value or unsupported cryptographic mechanism for a general authenticate operation, according to the standard (Table 12 of [SP 800-73] (http://piv.nist.gov/pivqa/faq.php?qid=122) or the card.
`static int`	`PIV_INVALID_OID` Object identifier is not one defined in ASN.1 OID (Table 6 of [SP 800-73]).
`static int`	`PIV_OK` Operation was successful.
`static int`	`PIV_SECURITY_CONDITIONS_NOT_SATISFIED` A call to the `pivLogIntoCardApplication()` application (typically present the PIN to the card) must be made before accessing the card operation and was not.
`static int`	`PIV_UNABLE_TO_LOAD_WRAPPER`
`static int`	`PIV_UNSUPPORTED_CRYPTOGRAPHIC_MECHANISM` The cryptographic mechanism value is not one of the algorithm identifiers found in Table 7 of [SP 800-73] or supported by the card.

- Field Detail
  - PIV_OK
```
static final int PIV_OK
```
    Operation was successful.
    
    See Also:
    
    Constant Field Values
  - PIV_CONNECTION_DESCRIPTION_MALFORMED
```
static final int PIV_CONNECTION_DESCRIPTION_MALFORMED
```
    The ConnectionDescription parameter in the function call does not conform to the required data format or the PC/SC returned one of the following error codes:
    - SCARD_E_UNKNOWN_READER
    - SCARD_E_DUPLICATE_READER
    See Also:
    
    Constant Field Values
  - PIV_CONNECTION_FAILURE
```
static final int PIV_CONNECTION_FAILURE
```
    There is no smart card in the reader or the smart card returned an unexpected answer or no answer at all or the PC/SC service is not started.
    
    See Also:
    
    Constant Field Values
  - PIV_CONNECTION_LOCKED
```
static final int PIV_CONNECTION_LOCKED
```
    A SCARD_E_SHARING_VIOLATION error was returned by PC/SC. Either:
    - A shared connection exists but an exclusive connection was requested, or
    - An exclusive connection exists but a shared/exclusive connection was requested.
    See Also:
    
    Constant Field Values
  - PIV_INVALID_CARD_HANDLE
```
static final int PIV_INVALID_CARD_HANDLE
```
    The communication handle is invalid. This generally happens when a function was called with an invalid card handle or when the smart card has been removed from the reader. The error corresponds to SCARD_E_INVALID_HANDLE from PC/SC.
    
    See Also:
    
    Constant Field Values
  - PIV_CARD_APPLICATION_NOT_FOUND
```
static final int PIV_CARD_APPLICATION_NOT_FOUND
```
    Application AID does not refer to an AID that the card supports.
    
    See Also:
    
    Constant Field Values
  - PIV_AUTHENTICATOR_MALFORMED
```
static final int PIV_AUTHENTICATOR_MALFORMED
```
    The authenticator's data objects to be used by the pivLogIntoCardApplication() function do not conform to the expected data format (Table 10 of [SP 800-73]).
    
    See Also:
    
    Constant Field Values
  - PIV_AUTHENTICATION_FAILURE
```
static final int PIV_AUTHENTICATION_FAILURE
```
    Authentication failed.
    
    See Also:
    
    Constant Field Values
  - PIV_INVALID_OID
```
static final int PIV_INVALID_OID
```
    Object identifier is not one defined in ASN.1 OID (Table 6 of [SP 800-73]).
    
    See Also:
    
    Constant Field Values
  - PIV_DATA_OBJECT_NOT_FOUND
```
static final int PIV_DATA_OBJECT_NOT_FOUND
```
    Object requested does not exist on the card.
    
    See Also:
    
    Constant Field Values
  - PIV_SECURITY_CONDITIONS_NOT_SATISFIED
```
static final int PIV_SECURITY_CONDITIONS_NOT_SATISFIED
```
    A call to the pivLogIntoCardApplication() application (typically present the PIN to the card) must be made before accessing the card operation and was not.
    
    See Also:
    
    Constant Field Values
  - PIV_INVALID_KEYREF_OR_ALGORITHM
```
static final int PIV_INVALID_KEYREF_OR_ALGORITHM
```
    Unsupported key reference value or unsupported cryptographic mechanism for a general authenticate operation, according to the standard (Table 12 of [SP 800-73] (http://piv.nist.gov/pivqa/faq.php?qid=122) or the card.
    
    See Also:
    
    Constant Field Values
  - PIV_INVALID_KEY_OR_KEYALG_COMBINATION
```
static final int PIV_INVALID_KEY_OR_KEYALG_COMBINATION
```
    Inconsistency in pivGenerateKeyPair() input parameters.
    
    See Also:
    
    Constant Field Values
  - PIV_INPUT_BYTES_MALFORMED
```
static final int PIV_INPUT_BYTES_MALFORMED
```
    Incorrect input data format (Table 17 of [SP 800-73]).
    
    See Also:
    
    Constant Field Values
  - PIV_INSUFFICIENT_CARD_RESOURCE
```
static final int PIV_INSUFFICIENT_CARD_RESOURCE
```
    The card does not have enough resources to perform this operation with the given parameter values. This error should never happen in normal use.
    
    See Also:
    
    Constant Field Values
  - PIV_UNSUPPORTED_CRYPTOGRAPHIC_MECHANISM
```
static final int PIV_UNSUPPORTED_CRYPTOGRAPHIC_MECHANISM
```
    The cryptographic mechanism value is not one of the algorithm identifiers found in Table 7 of [SP 800-73] or supported by the card.
    
    See Also:
    
    Constant Field Values
  - PIV_CARD_READER_ERROR
```
static final int PIV_CARD_READER_ERROR
```
    An unexpected APDU response or an unexpected response from the PC/SC layer was received. This usually happens when, for some reason, an event occurred that prevented communication with the card.
    
    See Also:
    
    Constant Field Values
  - PIV_INSUFFICIENT_BUFFER
```
static final int PIV_INSUFFICIENT_BUFFER
```
    Specified output buffer too small.
    
    See Also:
    
    Constant Field Values
  - PIV_UNABLE_TO_LOAD_WRAPPER
```
static final int PIV_UNABLE_TO_LOAD_WRAPPER
```
    See Also:
    
    Constant Field Values

Interface PIVReturnCodes

Field Summary

Field Detail

PIV_OK

PIV_CONNECTION_DESCRIPTION_MALFORMED

PIV_CONNECTION_FAILURE

PIV_CONNECTION_LOCKED

PIV_INVALID_CARD_HANDLE

PIV_CARD_APPLICATION_NOT_FOUND

PIV_AUTHENTICATOR_MALFORMED

PIV_AUTHENTICATION_FAILURE

PIV_INVALID_OID

PIV_DATA_OBJECT_NOT_FOUND

PIV_SECURITY_CONDITIONS_NOT_SATISFIED

PIV_INVALID_KEYREF_OR_ALGORITHM

PIV_INVALID_KEY_OR_KEYALG_COMBINATION

PIV_INPUT_BYTES_MALFORMED

PIV_INSUFFICIENT_CARD_RESOURCE

PIV_UNSUPPORTED_CRYPTOGRAPHIC_MECHANISM

PIV_CARD_READER_ERROR

PIV_INSUFFICIENT_BUFFER

PIV_UNABLE_TO_LOAD_WRAPPER