All Superinterfaces:: com.sun.jna.Library

public interface WinscardLibrary extends com.sun.jna.Library

The winscard API, also known as PC/SC.

Implementations of this API exist on Windows, OS X, and Linux, although the symbol names and sizeof parameters differs on different platforms.

Author:

gematik

See Also:

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jna.Library
com.sun.jna.Library.Handler
Field Summary

Fields

Modifier and Type

Field

Description

static final int

INFINITE

Infinite timeout.

static final String

PNP_READER_ID

Special value used to get notified of he arrival of another smart card reader.

static final int

SCARD_ABSENT

SCARD_ABSENT.

static final String

SCARD_ALL_READERS

Group used when no group name is provided when listing readers.

static final Dword

SCARD_AUTOALLOCATE

Special value used when indicating the length of an output buffer.

static final String

SCARD_DEFAULT_READERS

Default group to which all readers are added when introduced into the system.

static final int

SCARD_EJECT_CARD

SCARD_EJECT_CARD.

static final int

SCARD_LEAVE_CARD

SCARD_LEAVE_CARD.

static final String

SCARD_LOCAL_READERS

Deprecated.
i.e. legacy value

static final int

SCARD_NEGOTIABLE

SCARD_NEGOTIABLE.

static final int

SCARD_POWERED

SCARD_POWERED.

static final int

SCARD_PRESENT

SCARD_PRESENT.

static final int

SCARD_PROTOCOL_RAW

SCARD_PROTOCOL_RAW.

static final int

SCARD_PROTOCOL_T0

SCARD_PROTOCOL_T0.

static final int

SCARD_PROTOCOL_T1

SCARD_PROTOCOL_T1.

static final int

SCARD_PROTOCOL_UNDEFINED

SCARD_PROTOCOL_UNDEFINED.

static final int

SCARD_RESET_CARD

SCARD_RESET_CARD.

static final int

SCARD_SCOPE_SYSTEM

Scope system.

static final int

SCARD_SCOPE_TERMINAL

Scope terminal.

static final int

SCARD_SCOPE_USER

Scope user.

static final int

SCARD_SHARE_DIRECT

SCARD_SHARE_DIRECT.

static final int

SCARD_SHARE_EXCLUSIVE

SCARD_SHARE_EXCLUSIVE.

static final int

SCARD_SHARE_SHARED

SCARD_SHARE_SHARED.

static final int

SCARD_SPECIFIC

SCARD_SPECIFIC.

static final int

SCARD_STATE_ATRMATCH

ATR matches card.

static final int

SCARD_STATE_CHANGED

State has changed.

static final int

SCARD_STATE_EMPTY

Card removed.

static final int

SCARD_STATE_EXCLUSIVE

Exclusive Mode.

static final int

SCARD_STATE_IGNORE

Ignore this reader.

static final int

SCARD_STATE_INUSE

Shared Mode.

static final int

SCARD_STATE_MUTE

Unresponsive card.

static final int

SCARD_STATE_PRESENT

Card inserted.

static final int

SCARD_STATE_UNAVAILABLE

Status unavailable.

static final int

SCARD_STATE_UNAWARE

App wants status.

static final int

SCARD_STATE_UNKNOWN

Reader unknown.

static final int

SCARD_STATE_UNPOWERED

Unpowered card.

static final int

SCARD_SWALLOWED

SCARD_SWALLOWED.

static final String

SCARD_SYSTEM_READERS

Deprecated.
i.e. legacy value

static final int

SCARD_UNKNOWN

SCARD_UNKNOWN.

static final int

SCARD_UNPOWER_CARD

SCARD_UNPOWER_CARD.

Fields inherited from interface com.sun.jna.Library
OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_SYMBOL_PROVIDER, OPTION_TYPE_MAPPER
Method Summary

Modifier and Type

Method

Description

Dword

SCardConnect(ScardContext hContext, String szReader, Dword dwSharMode, Dword dwPreferredProtocols, ScardHandleByReference phCard, DwordByReference pdwActiveProtocol)

Establishes a connection to a smart card.

Dword

SCardDisconnect(ScardHandle hCard, Dword dwDisposition)

Terminates a connection between an application and a smart card.

Dword

SCardEstablishContext(Dword dwScope, com.sun.jna.Pointer pvReserved1, com.sun.jna.Pointer pvReserved2, ScardContextByReference phContext)

Establishes a context.

Dword

SCardGetStatusChange(ScardContext hContext, Dword dwTimeout, ScardReaderState[] rgReaderStates, Dword cReaders)

Provides a status for a specific set of readers.

Dword

SCardListReaders(ScardContext hContext, ByteBuffer mszGroups, ByteBuffer mszReaders, DwordByReference pcchReaders)

Provides a list of readers.

Dword

SCardReleaseContext(ScardContext hContext)

Releases a context.

Dword

SCardStatus(ScardHandle hCard, ByteBuffer mszReaderName, DwordByReference pcchReaderLen, DwordByReference pdwState, DwordByReference pdwProtocol, ByteBuffer pbAtr, DwordByReference pcbAtrLen)

Retrieves the current status of a smart card in a reader.

Dword

SCardTransmit(ScardHandle hCard, ScardIoRequest pioSendPci, ByteBuffer pbSendBuffer, Dword cbSendLength, ScardIoRequest pioRecvPci, ByteBuffer pbRecvBuffer, DwordByReference pcbRecvLength)

Transmits data to and from a connected smart card.

Field Details
- INFINITE
  
  static final int INFINITE
  
  Infinite timeout.
  See Also:
  
  pcsclite.h.in
  
  Constant Field Values
- PNP_READER_ID
  
  static final String PNP_READER_ID
  
  Special value used to get notified of he arrival of another smart card reader.
  This special value is used in SCardGetStatusChange(ScardContext, Dword, ScardReaderState[], Dword) for being notified of the arrival of a new smart card reader.
  See Also:
  
  MSDN SCardGetStatusChange
  
  Constant Field Values
- SCARD_AUTOALLOCATE
  
  static final Dword SCARD_AUTOALLOCATE
  Special value used when indicating the length of an output buffer.
  Notes:
  
  Mac OS X does not (yet) support memory (auto) allocation in the PC/SC layer. So you have to use a double call mechanism. One first call to get the size to allocate and one second call with a buffer allocated at the correct size, see Ludovic Rousseau's blog
  Auto-allocation seems not to work with JAVA.
  See Also:
  
  MSDN definition
- SCARD_ALL_READERS
  
  static final String SCARD_ALL_READERS
  
  Group used when no group name is provided when listing readers.
  Returns a list of all readers, regardless of what group or groups the readers are in.
  See Also:
  
  MSDN SCardListReaders function
  
  Constant Field Values
- SCARD_DEFAULT_READERS
  
  static final String SCARD_DEFAULT_READERS
  
  Default group to which all readers are added when introduced into the system.
  See Also:
  
  MSDN SCardListReaders function
  
  Constant Field Values
- SCARD_LOCAL_READERS
  
  @Deprecated(since="legacy value") static final String SCARD_LOCAL_READERS
  
  Deprecated.
  i.e. legacy value
  
  Unused legacy value.
  This is an internally managed group that cannot be modified by using any reader group APIs. It is intended to be used for enumeration only.
  See Also:
  
  MSDN SCardListReaders function
  
  Constant Field Values
- SCARD_SYSTEM_READERS
  
  @Deprecated(since="legacy value") static final String SCARD_SYSTEM_READERS
  
  Deprecated.
  i.e. legacy value
  
  Unused legacy value.
  This is an internally managed group that cannot be modified by using any reader group APIs. It is intended to be used for enumeration only.
  See Also:
  
  MSDN SCardListReaders function
  
  Constant Field Values
- SCARD_PROTOCOL_UNDEFINED
  
  static final int SCARD_PROTOCOL_UNDEFINED
  
  SCARD_PROTOCOL_UNDEFINED.
  See Also:
  
  pcsclite.h.in
  
  MSDN SCardConnect function
  
  Constant Field Values
- SCARD_PROTOCOL_T0
  
  static final int SCARD_PROTOCOL_T0
  
  SCARD_PROTOCOL_T0.
  See Also:
  
  pcsclite.h.in
  
  MSDN SCardConnect function
  
  Constant Field Values
- SCARD_PROTOCOL_T1
  
  static final int SCARD_PROTOCOL_T1
  
  SCARD_PROTOCOL_T1.
  See Also:
  
  pcsclite.h.in
  
  MSDN SCardConnect function
  
  Constant Field Values
- SCARD_PROTOCOL_RAW
  
  static final int SCARD_PROTOCOL_RAW
  
  SCARD_PROTOCOL_RAW.
  Raw active protocol.
  See Also:
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_LEAVE_CARD
  
  static final int SCARD_LEAVE_CARD
  
  SCARD_LEAVE_CARD.
  Do not do anything special.
  See Also:
  
  MSDN SCardDisconnect function
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_RESET_CARD
  
  static final int SCARD_RESET_CARD
  
  SCARD_RESET_CARD.
  Reset the card.
  See Also:
  
  MSDN SCardDisconnect function
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_UNPOWER_CARD
  
  static final int SCARD_UNPOWER_CARD
  
  SCARD_UNPOWER_CARD.
  Power down the card.
  See Also:
  
  MSDN SCardDisconnect function
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_EJECT_CARD
  
  static final int SCARD_EJECT_CARD
  
  SCARD_EJECT_CARD.
  Eject the card.
  See Also:
  
  MSDN SCardDisconnect function
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_SCOPE_USER
  
  static final int SCARD_SCOPE_USER
  
  Scope user.
  Database operations are performed within the domain of the user, see SCardEstablishContext(Dword, Pointer, Pointer, ScardContextByReference)
  See Also:
  
  MSDN SCardEstablishContext function
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_SCOPE_TERMINAL
  
  static final int SCARD_SCOPE_TERMINAL
  
  Scope terminal.
  Note: This constants is defined in pcsclite.h.in but not mentioned in MSDN SCardEstablishContext function
  See Also:
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_SCOPE_SYSTEM
  
  static final int SCARD_SCOPE_SYSTEM
  
  Scope system.
  Database operations are performed within the domain of the system. The calling application must have appropriate access permissions for any database actions, see SCardEstablishContext(Dword, Pointer, Pointer, ScardContextByReference)
  See Also:
  
  MSDN SCardEstablishContext function
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_SHARE_EXCLUSIVE
  
  static final int SCARD_SHARE_EXCLUSIVE
  
  SCARD_SHARE_EXCLUSIVE.
  This application is not willing to share the card with other applications.
  See Also:
  
  MSDN SCardConnect function
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_SHARE_SHARED
  
  static final int SCARD_SHARE_SHARED
  
  SCARD_SHARE_SHARED.
  This application is willing to share the card with other applications.
  See Also:
  
  MSDN SCardConnect function
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_SHARE_DIRECT
  
  static final int SCARD_SHARE_DIRECT
  
  SCARD_SHARE_DIRECT.
  This application is allocating the reader for its private use, and will be controlling it directly. No other applications are allowed access to it.
  See Also:
  
  MSDN SCardConnect function
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_STATE_UNAWARE
  
  static final int SCARD_STATE_UNAWARE
  
  App wants status.
  dwCurrentState The application is unaware of the current state, and would like to know. The use of this value results in an immediate return from state transition monitoring services. This is represented by all bits set to zero.
  dwEventState Not mentioned.
  See Also:
  
  MSDN SCARD_READERSTATE
  
  MSDN Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_STATE_IGNORE
  
  static final int SCARD_STATE_IGNORE
  
  Ignore this reader.
  dwCurrentState The application is not interested in this reader, and it should not be considered during monitoring operations. If this bit value is set, all other bits are ignored.
  dwEventState This reader should be ignored.
  See Also:
  
  MSDN SCARD_READERSTATE
  
  MSDN Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_STATE_CHANGED
  
  static final int SCARD_STATE_CHANGED
  
  State has changed.
  dwCurrentState Not mentioned.
  dwEventState There is a difference between the state believed by the application, and the state known by the resource manager. When this bit is set, the application may assume a significant state change has occurred on this reader.
  See Also:
  
  MSDN SCARD_READERSTATE
  
  MSDN Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_STATE_UNKNOWN
  
  static final int SCARD_STATE_UNKNOWN
  
  Reader unknown.
  dwCurrentState Not mentioned.
  dwEventState The given reader name is not recognized by the resource manager. If this bit is set, then SCARD_STATE_CHANGED and SCARD_STATE_IGNORE will also be set.
  See Also:
  
  MSDN SCARD_READERSTATE
  
  MSDN Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_STATE_UNAVAILABLE
  
  static final int SCARD_STATE_UNAVAILABLE
  
  Status unavailable.
  dwCurrentState The application expects that this reader is not available for use. If this bit is set, then all the following bits are ignored.
  dwEventState The actual state of this reader is not available. If this bit is set, then all the following bits are clear.
  See Also:
  
  MSDN SCARD_READERSTATE
  
  MSDN Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_STATE_EMPTY
  
  static final int SCARD_STATE_EMPTY
  
  Card removed.
  dwCurrentState The application expects that there is no card in the reader. If this bit is set, all the following bits are ignored.
  dwEventState There is no card in the reader. If this bit is set, all the following bits will be clear.
  See Also:
  
  MSDN SCARD_READERSTATE
  
  MSDN Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_STATE_PRESENT
  
  static final int SCARD_STATE_PRESENT
  
  Card inserted.
  dwCurrentState The application expects that there is a card in the reader.
  dwEventState There is a card in the reader.
  See Also:
  
  MSDN SCARD_READERSTATE
  
  MSDN Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_STATE_ATRMATCH
  
  static final int SCARD_STATE_ATRMATCH
  
  ATR matches card.
  dwCurrentState The application expects that there is a card in the reader with an ATR that matches one of the target cards. If this bit is set, SCARD_STATE_PRESENT is assumed. This bit has no meaning to SCardGetStatusChange beyond SCARD_STATE_PRESENT.
  dwEventState There is a card in the reader with an ATR matching one of the target cards. If this bit is set, SCARD_STATE_PRESENT will also be set. This bit is only returned on the TODO SCardLocateCards function.
  See Also:
  
  MSDN SCARD_READERSTATE
  
  MSDN Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_STATE_EXCLUSIVE
  
  static final int SCARD_STATE_EXCLUSIVE
  
  Exclusive Mode.
  dwCurrentState The application expects that the card in the reader is allocated for exclusive use by another application. If this bit is set, SCARD_STATE_PRESENT is assumed.
  dwEventState The card in the reader is allocated for exclusive use by another application. If this bit is set, SCARD_STATE_PRESENT will also be set.
  See Also:
  
  MSDN SCARD_READERSTATE
  
  MSDN Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_STATE_INUSE
  
  static final int SCARD_STATE_INUSE
  
  Shared Mode.
  dwCurrentState The application expects that the card in the reader is in use by one or more other applications, but may be connected to in shared mode. If this bit is set, SCARD_STATE_PRESENT is assumed.
  dwEventState The card in the reader is in use by one or more other applications, but may be connected to in shared mode. If this bit is set, SCARD_STATE_PRESENT will also be set.
  See Also:
  
  MSDN SCARD_READERSTATE
  
  MSDN Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_STATE_MUTE
  
  static final int SCARD_STATE_MUTE
  
  Unresponsive card.
  dwCurrentState The application expects that there is an unresponsive card in the reader.
  dwEventState There is an unresponsive card in the reader.
  See Also:
  
  MSDN SCARD_READERSTATE
  
  MSDN Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_STATE_UNPOWERED
  
  static final int SCARD_STATE_UNPOWERED
  
  Unpowered card.
  dwCurrentState This implies that the card in the reader has not been powered up.
  dwEventState Identical meaning as for dwCurrentState.
  See Also:
  
  MSDN SCARD_READERSTATE
  
  MSDN Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_UNKNOWN
  
  static final int SCARD_UNKNOWN
  SCARD_UNKNOWN.
  The current state of the reader is unknown.
  Notes:
  
  If p is defined as the value from pcsclite.h.in and m is defined as the value from MSDN Card/Reader State then it is: p = 2^m.
  Hereafter the value from MSDN Card/Reader State is used, which is identical to the value from Sun's PlatformPCSC.java.
  See Also:
  
  MSDN Card/Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_ABSENT
  
  static final int SCARD_ABSENT
  SCARD_ABSENT.
  There is no card in the reader.
  Notes:
  
  If p is defined as the value from pcsclite.h.in and m is defined as the value from MSDN Card/Reader State then it is: p = 2^m.
  Hereafter the value from MSDN Card/Reader State is used, which is identical to the value from Sun's PlatformPCSC.java.
  See Also:
  
  MSDN Card/Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_PRESENT
  
  static final int SCARD_PRESENT
  SCARD_PRESENT.
  There is a card in the reader, but it has not been moved into position for use.
  Notes:
  
  If p is defined as the value from pcsclite.h.in and m is defined as the value from MSDN Card/Reader State then it is: p = 2^m.
  Hereafter the value from MSDN Card/Reader State is used, which is identical to the value from Sun's PlatformPCSC.java.
  See Also:
  
  MSDN Card/Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_SWALLOWED
  
  static final int SCARD_SWALLOWED
  SCARD_SWALLOWED.
  There is a card in the reader in position for use. The card is not powered.
  Notes:
  
  If p is defined as the value from pcsclite.h.in and m is defined as the value from MSDN Card/Reader State then it is: p = 2^m.
  Hereafter the value from MSDN Card/Reader State is used, which is identical to the value from Sun's PlatformPCSC.java.
  See Also:
  
  MSDN Card/Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_POWERED
  
  static final int SCARD_POWERED
  SCARD_POWERED.
  Power is being provided to the card, but the reader driver is unaware of the mode of the card.
  Notes:
  
  If p is defined as the value from pcsclite.h.in and m is defined as the value from MSDN Card/Reader State then it is: p = 2^m.
  Hereafter the value from MSDN Card/Reader State is used, which is identical to the value from Sun's PlatformPCSC.java.
  See Also:
  
  MSDN Card/Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_NEGOTIABLE
  
  static final int SCARD_NEGOTIABLE
  SCARD_NEGOTIABLE.
  The card has been reset and is awaiting PTS negotiation.
  Notes:
  
  If p is defined as the value from pcsclite.h.in and m is defined as the value from MSDN Card/Reader State then it is: p = 2^m.
  Hereafter the value from MSDN Card/Reader State is used, which is identical to the value from Sun's PlatformPCSC.java.
  See Also:
  
  MSDN Card/Reader State
  
  pcsclite.h.in
  
  Constant Field Values
- SCARD_SPECIFIC
  
  static final int SCARD_SPECIFIC
  SCARD_SPECIFIC.
  The card has been reset and specific communication protocols have been established.
  Notes:
  
  If p is defined as the value from pcsclite.h.in and m is defined as the value from MSDN Card/Reader State then it is: p = 2^m.
  Hereafter the value from MSDN Card/Reader State is used, which is identical to the value from Sun's PlatformPCSC.java.
  See Also:
  
  MSDN Card/Reader State
  
  pcsclite.h.in
  
  Constant Field Values
Method Details
- SCardEstablishContext
  
  Dword SCardEstablishContext(Dword dwScope, @Nullable com.sun.jna.Pointer pvReserved1, @Nullable com.sun.jna.Pointer pvReserved2, ScardContextByReference phContext)
  Establishes a context.
  The SCardEstablishContext function establishes the resource manager context (the scope) within which database operations are performed.
  Remarks:
  
  The context handle returned by the SCardEstablishContext function can be used by database query and management functions. For more information, see Smart Card Database Query Functions and Smart Card Database Management Functions.
  To release an established resource manager context, use SCardReleaseContext(de.gematik.smartcards.pcsc.lib.ScardContext).
  Parameters:
  
  dwScope - [in] Scope of the resource manager context. This parameter can be one of the following values.
  
  SCARD_SCOPE_USER Database operations are performed within the domain of the user.
  SCARD_SCOPE_SYSTEM Database operations are performed within the domain of the system. The calling application must have appropriate access permissions for any database actions.
  
  pvReserved1 - [in] Reserved for future use and must be NULL. This parameter will allow a suitably privileged management application to act on behalf of another user.
  
  pvReserved2 - [in] Reserved for future use and must be NULL.
  
  phContext - [out] A handle to the established resource manager context. This handle can now be supplied to other functions attempting to do work within this context.
  
  Returns:
  
  If the function succeeds, the function returns SCARD_S_SUCCESS. If the function fails, it returns an error code. For more information, see Smart Card Return Values or PcscStatus.
  
  See Also:
  
  MSDN SCardEstablishContext function
- SCardListReaders
  
  Dword SCardListReaders(@Nullable ScardContext hContext, @Nullable ByteBuffer mszGroups, @Nullable ByteBuffer mszReaders, DwordByReference pcchReaders)
  Provides a list of readers.
  The SCardListReaders function provides the list of readers within a set of named reader groups, eliminating duplicates.
  The caller supplies a list of reader groups, and receives the list of readers within the named groups. Unrecognized group names are ignored. This function only returns readers within the named groups that are currently attached to the system and available for use.
  Remarks:
  
  The SCardListReaders function is a database query function. For more information about other database query functions, see Smart Card Database Query Functions.
  Parameters:
  
  hContext - [in] Handle that identifies the resource manager context for the query. The resource manager context can be set by a previous call to SCardEstablishContext(de.gematik.smartcards.pcsc.lib.Dword, com.sun.jna.Pointer, com.sun.jna.Pointer, de.gematik.smartcards.pcsc.lib.ScardContextByReference). If this parameter is set to NULL, the search for readers is not limited to any context.
  
  mszGroups - [in, optional] Names of the reader groups defined to the system, as a multi-string. Use a NULL value to list all readers in the system (that is, the "SCard$AllReaders" group), see SCARD_ALL_READERS, SCARD_DEFAULT_READERS, SCARD_LOCAL_READERS, SCARD_SYSTEM_READERS.
  
  mszReaders - [out] Multi-string that lists the card readers within the supplied reader groups. If this value is NULL, SCardListReaders ignores the buffer length supplied in pcchReaders, writes the length of the buffer that would have been returned if this parameter had not been NULL to pcchReaders, and returns a success code.
  
  pcchReaders - [in, out] Length of the mszReaders buffer in characters. This parameter receives the actual length of the multi-string structure, including all trailing NULL characters. If the buffer length is specified as SCARD_AUTOALLOCATE, then mszReaders is converted to a pointer to a byte pointer, and receives the address of a block of memory containing the multi-string structure. This block of memory must be deallocated with TODO #SCardFreeMemory.
  
  Returns:
  
  This function returns different values depending on whether it succeeds or fails.
  
  Success: SCARD_S_SUCCESS
  Group contains no readers: SCARD_E_NO_READERS_AVAILABLE
  Specified reader is not currently available for use: SCARD_E_READER_UNAVAILABLE
  Other: An error code. For more information, see Smart Card Return Values or PcscStatus.
  
  See Also:
  
  MSDN SCardListReaders function
- SCardGetStatusChange
  
  Dword SCardGetStatusChange(ScardContext hContext, Dword dwTimeout, ScardReaderState[] rgReaderStates, Dword cReaders)
  Provides a status for a specific set of readers.
  The SCardGetStatusChange function blocks execution until the current availability of the cards in a specific set of readers changes.
  The caller supplies a list of readers to be monitored by an ScardReaderState array and the maximum amount of time (in milliseconds) that it is willing to wait for an action to occur on one of the listed readers. Note that SCardGetStatusChange uses the user-supplied value in the dwCurrentState members of the rgReaderStates array as the definition of the current state of the readers. The function returns when there is a change in availability, having filled in the dwEventState members of rgReaderStates appropriately.
  Remarks:
  
  The SCardGetStatusChange function is a smart card tracking function. For more information about other tracking functions, see MSDN Smart Card Tracking Functions.
  Parameters:
  
  hContext - [in] A handle that identifies the resource manager context The resource manager context is set by a previous call to SCardEstablishContext(Dword, Pointer, Pointer, ScardContextByReference).
  
  dwTimeout - [in] The maximum amount of time, in milliseconds, to wait for an action. A value of zero causes the function to return immediately. A value of INFINITE causes this function never to time out.
  
  rgReaderStates - [in, out] An array of ScardReaderState structures that specify the readers to watch, and that receives the result.
  To be notified of the arrival of a new smart card reader, set the szReader member of a ScardReaderState structure to PNP_READER_ID, and set all of the other members of that structure to zero.
  Important: Each member of each structure in this array must be initialized to zero and then set to specific values as necessary. If this is not done, the function will fail in situations that involve remote card readers.
  
  cReaders - [in] The number of elements in the rgReaderStates array.
  
  Returns:
  
  This function returns different values depending on whether it succeeds or fails.
  
  Success: SCARD_S_SUCCESS
  Failure: An error code. For more information, see Smart Card Return Values or PcscStatus.
  
  See Also:
  
  MSDN SCardGetStatusChange function
- SCardConnect
  
  Dword SCardConnect(ScardContext hContext, String szReader, Dword dwSharMode, Dword dwPreferredProtocols, ScardHandleByReference phCard, DwordByReference pdwActiveProtocol)
  Establishes a connection to a smart card.
  The SCardConnect function establishes a connection (using a specific resource manager context) between the calling application and a smart card contained by a specific reader. If no card exists in the specified reader, an error is returned.
  Remarks:
  
  The SCardConnect function is a smart card and reader access function. For more information about other access functions, see Smart Card and Reader Access Functions.
  Parameters:
  
  hContext - [in] A handle that identifies the resource manager context The resource manager context is set by a previous call to SCardEstablishContext(Dword, Pointer, Pointer, ScardContextByReference).
  
  szReader - [in] The name of the reader that contains the target card.
  
  dwSharMode - [in] A flag that indicates whether other applications may form connections to the card. See SCARD_SHARE_SHARED, SCARD_SHARE_EXCLUSIVE, SCARD_SHARE_DIRECT.
  
  dwPreferredProtocols - [in] A bitmask of acceptable protocols for the connection. Possible values may be combined with the OR operation.
  
  SCARD_PROTOCOL_T0: T=0 is an acceptable protocol.
  SCARD_PROTOCOL_T1: T=1 is an acceptable protocol.
  SCARD_PROTOCOL_UNDEFINED: This parameter may be zero only if dwShareMode is set to SCARD_SHARE_DIRECT. In this case, no protocol negotiation will be performed by the drivers until an IOCTL_SMARTCARD_SET_PROTOCOL control directive is sent with TODO SCardControl.
  
  phCard - [out] A handle that identifies the connection to the smart card in the designated reader.
  
  pdwActiveProtocol - [out] A flag that indicates the established active protocol.
  
  SCARD_PROTOCOL_T0: T=0 is the active protocol.
  SCARD_PROTOCOL_T1: T=1 is the active protocol.
  SCARD_PROTOCOL_UNDEFINED: SCARD_SHARE_DIRECT has been specified, so that no protocol negotiation has occurred. It is possible that there is no card in the reader.
  
  Returns:
  
  This function returns different values depending on whether it succeeds or fails.
  
  Success: SCARD_S_SUCCESS
  Failure: An error code. For more information, see Smart Card Return Values or PcscStatus.
  SCARD_E_NOT_READY The reader was unable to connect to the card.
  
  See Also:
  
  MSDN SCardConnect function
- SCardStatus
  
  Dword SCardStatus(ScardHandle hCard, @Nullable ByteBuffer mszReaderName, DwordByReference pcchReaderLen, DwordByReference pdwState, DwordByReference pdwProtocol, ByteBuffer pbAtr, DwordByReference pcbAtrLen)
  Retrieves the current status of a smart card in a reader.
  The SCardStatus function provides the current status of a smart card in a reader. You can call it any time after a successful call to SCardConnect(de.gematik.smartcards.pcsc.lib.ScardContext, java.lang.String, de.gematik.smartcards.pcsc.lib.Dword, de.gematik.smartcards.pcsc.lib.Dword, de.gematik.smartcards.pcsc.lib.ScardHandleByReference, de.gematik.smartcards.pcsc.lib.DwordByReference) and before a successful call to SCardDisconnect(de.gematik.smartcards.pcsc.lib.ScardHandle, de.gematik.smartcards.pcsc.lib.Dword). It does not affect the state of the reader or reader driver.
  Remarks:
  
  The SCardStatus function is a smart card and reader access function. For information about other access functions, see Smart Card and Reader Access Functions.
  For the T=0 protocol, the data received back are the SW1 and SW2 status codes, possibly preceded by response data.
  Parameters:
  
  hCard - [in] Reference value obtained from SCardConnect(de.gematik.smartcards.pcsc.lib.ScardContext, java.lang.String, de.gematik.smartcards.pcsc.lib.Dword, de.gematik.smartcards.pcsc.lib.Dword, de.gematik.smartcards.pcsc.lib.ScardHandleByReference, de.gematik.smartcards.pcsc.lib.DwordByReference).
  
  mszReaderName - [out] List of display names (multiple string) by which the currently connected reader is known.
  
  pcchReaderLen - [in, out, optional] On input, supplies the length of the mszReaderName buffer. On output, receives the actual length (in characters) of the reader name list, including the trailing NULL character. If this buffer length is specified as SCARD_AUTOALLOCATE, then mszReaderName is converted to a pointer to a byte pointer, and it receives the address of a block of memory that contains the multiple-string structure.
  
  pdwState - [out, optional] Current state of the smart card in the reader. Upon success, it receives one of the following state indicators.
  
  SCARD_ABSENT
  SCARD_PRESENT
  SCARD_SWALLOWED
  SCARD_POWERED
  SCARD_NEGOTIABLE
  SCARD_SPECIFIC
  
  pdwProtocol - [out, optional] Current protocol, if any. The returned value is meaningful only if the returned value of pdwState is SCARD_SPECIFIC.
  
  SCARD_PROTOCOL_RAW: The Raw Transfer protocol is in use.
  SCARD_PROTOCOL_T0: The ISO/IEC 7816-3 T=0 protocol is in use.
  SCARD_PROTOCOL_T1: The ISO/IEC 7816-3 T=1 protocol is in use.
  
  pbAtr - [out] Pointer to a byte buffer that receives the Answer-To-Reset from the currently inserted card, if available.
  
  pcbAtrLen - [in, out, optional] On input, supplies the length of the pbAtr buffer. On output, receives the number of bytes in the ATR string (32 bytes maximum). If this buffer length is specified as SCARD_AUTOALLOCATE, then pbAtr is converted to a pointer to a byte pointer, and it receives the address of a block of memory that contains the multiple-string structure.
  Remark afi: I am pretty sure that here thirty three bytes is the maximum. For explanation see AnswerToReset.MAX_ATR_SIZE.
  
  Returns:
  
  If the function successfully provides the current status of a smart card in a reader, the return value is PcscStatus.SCARD_S_SUCCESS. If the function fails, it returns an error code. For more information, see Smart Card Return Values or PcscStatus.
  
  See Also:
  
  MSDN SCardStatus function
- SCardTransmit
  
  Dword SCardTransmit(ScardHandle hCard, ScardIoRequest pioSendPci, ByteBuffer pbSendBuffer, Dword cbSendLength, @Nullable ScardIoRequest pioRecvPci, ByteBuffer pbRecvBuffer, DwordByReference pcbRecvLength)
  Transmits data to and from a connected smart card.
  The SCardTransmit function sends a service request to the smart card and expects to receive data back from the card.
  Remarks:
  
  The SCardTransmit function is a smart card and reader access function. For information about other access functions, see Smart Card and Reader Access Functions.
  For the T=0 protocol, the data received back are the SW1 and SW2 status codes, possibly preceded by response data.
  Parameters:
  
  hCard - [in] A reference value obtained from the SCardConnect(de.gematik.smartcards.pcsc.lib.ScardContext, java.lang.String, de.gematik.smartcards.pcsc.lib.Dword, de.gematik.smartcards.pcsc.lib.Dword, de.gematik.smartcards.pcsc.lib.ScardHandleByReference, de.gematik.smartcards.pcsc.lib.DwordByReference) function.
  
  pioSendPci - [in] A pointer to the protocol header structure for the instruction. This buffer is in the format of an ScardIoRequest structure, followed by the specific protocol control information (PCI).
  For the T=0, T=1, and RAW protocols, the PCI structure is constant. The smart card subsystem supplies a global T=0, T=1, or Raw PCI structure.
  
  pbSendBuffer - [in] A pointer to the actual data to be written to the card.
  For T=0, the data parameters are placed into the address pointed to by {code pbSendBuffer} according to the following structure:
  struct{ BYTE CLA, INS, P1, P2, P3;} CmdBytes.
  The data sent to the card should immediately follow the send buffer. In the special case where no data is sent to the card and no data is expected in return (i.e. case 1 according to ISO/IEC 7816-3:2006 12.1.2), P3 is not sent.
  Remark afi: I am pretty sure that P3 is sent to the card, see ISO/IEC 7816-3:2006 12.2.2.
  
  cbSendLength - [in] The length, in bytes, of the pbSendBuffer parameter.
  For T=0, in the special case where no data is sent to the card and no data expected in return (i.e. case 1 according to ISO/IEC 7816-3:2006 12.1.2), this length must reflect that the P3 member is not being sent.
  Remark afi: I am pretty sure that P3 is sent to the card, see ISO/IEC 7816-3:2006 12.2.2.
  
  pioRecvPci - [in, out, optional] Pointer to the protocol header structure for the instruction, followed by a buffer in which to receive any returned protocol control information (PCI) specific to the protocol in use. This parameter can be NULL if no PCI is returned.
  
  pbRecvBuffer - [out] Pointer to any data returned from the card.
  For T=0, the data is immediately followed by the SW1 and SW2 status bytes. If no data is returned from the card, then this buffer will only contain the SW1 and SW2 status bytes.
  
  pcbRecvLength - [in, out] Supplies the length, in bytes, of the pbRecvBuffer parameter and receives the actual number of bytes received from the smart card. This value cannot be SCARD_AUTOALLOCATE because SCardTransmit does not support SCARD_AUTOALLOCATE.
  For T=0, the receive buffer must be at least two bytes long to receive the SW1 and SW2 status bytes.
  
  Returns:
  
  If the function successfully sends a service request to the smart card, the return value is PcscStatus.SCARD_S_SUCCESS. If the function fails, it returns an error code. For more information, see Smart Card Return Values or PcscStatus.
  
  See Also:
  
  MSDN SCardTransmit function
- SCardDisconnect
  
  Dword SCardDisconnect(ScardHandle hCard, Dword dwDisposition)
  Terminates a connection between an application and a smart card.
  The SCardDisconnect function terminates a connection previously opened between the calling application and a smart card in the target reader.
  Remarks:
  
  If an application (which previously called SCardConnect(de.gematik.smartcards.pcsc.lib.ScardContext, java.lang.String, de.gematik.smartcards.pcsc.lib.Dword, de.gematik.smartcards.pcsc.lib.Dword, de.gematik.smartcards.pcsc.lib.ScardHandleByReference, de.gematik.smartcards.pcsc.lib.DwordByReference)) exits without calling SCardDisconnect, the card is automatically reset.
  The SCardDisconnect function is a smart card and reader access function. For more information about other access functions, see Smart Card and Reader Access Functions.
  Parameters:
  
  hCard - [in] Reference value obtained from a previous call to SCardConnect(de.gematik.smartcards.pcsc.lib.ScardContext, java.lang.String, de.gematik.smartcards.pcsc.lib.Dword, de.gematik.smartcards.pcsc.lib.Dword, de.gematik.smartcards.pcsc.lib.ScardHandleByReference, de.gematik.smartcards.pcsc.lib.DwordByReference).
  
  dwDisposition - [in] Action to take on the card in the connected reader on close.
  
  SCARD_LEAVE_CARD: Do not do anything special.
  SCARD_RESET_CARD: Reset the card.
  SCARD_UNPOWER_CARD: Power down the card.
  SCARD_EJECT_CARD: Eject the card.
  
  Returns:
  
  This function returns different values depending on whether it succeeds or fails.
  
  Success: SCARD_S_SUCCESS
  Failure: An error code. For more information, see Smart Card Return Values or PcscStatus.
  
  See Also:
  
  MSDN SCardDisconnect function
- SCardReleaseContext
  
  Dword SCardReleaseContext(ScardContext hContext)
  
  Releases a context.
  The SCardReleaseContext function closes an established resource manager context freeing any resources allocated under that context, including SCARDHANDLE objects and memory allocated using the SCARD_AUTOALLOCATE length designator.
  Parameters:
  
  hContext - [in] Handle that identifies the resource manager context The resource manager context is set by a previous call to SCardEstablishContext(de.gematik.smartcards.pcsc.lib.Dword, com.sun.jna.Pointer, com.sun.jna.Pointer, de.gematik.smartcards.pcsc.lib.ScardContextByReference).
  
  Returns:
  
  This function returns different values depending on whether it succeeds or fails.
  
  Success: SCARD_S_SUCCESS
  Failure: An error code. For more information, see Smart Card Return Values or PcscStatus.
  
  See Also:
  
  MSDN SCardReleaseContext function

Interface WinscardLibrary

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jna.Library

Field Summary

Fields inherited from interface com.sun.jna.Library

Method Summary

Field Details

INFINITE

PNP_READER_ID

SCARD_AUTOALLOCATE

SCARD_ALL_READERS

SCARD_DEFAULT_READERS

SCARD_LOCAL_READERS

SCARD_SYSTEM_READERS

SCARD_PROTOCOL_UNDEFINED

SCARD_PROTOCOL_T0

SCARD_PROTOCOL_T1

SCARD_PROTOCOL_RAW

SCARD_LEAVE_CARD

SCARD_RESET_CARD

SCARD_UNPOWER_CARD

SCARD_EJECT_CARD

SCARD_SCOPE_USER

SCARD_SCOPE_TERMINAL

SCARD_SCOPE_SYSTEM

SCARD_SHARE_EXCLUSIVE

SCARD_SHARE_SHARED

SCARD_SHARE_DIRECT

SCARD_STATE_UNAWARE

SCARD_STATE_IGNORE

SCARD_STATE_CHANGED

SCARD_STATE_UNKNOWN

SCARD_STATE_UNAVAILABLE

SCARD_STATE_EMPTY

SCARD_STATE_PRESENT

SCARD_STATE_ATRMATCH

SCARD_STATE_EXCLUSIVE

SCARD_STATE_INUSE

SCARD_STATE_MUTE

SCARD_STATE_UNPOWERED

SCARD_UNKNOWN

SCARD_ABSENT

SCARD_PRESENT

SCARD_SWALLOWED

SCARD_POWERED

SCARD_NEGOTIABLE

SCARD_SPECIFIC

Method Details

SCardEstablishContext

SCardListReaders

SCardGetStatusChange

SCardConnect

SCardStatus

SCardTransmit

SCardDisconnect

SCardReleaseContext