Portuguese eID Middleware SDK Version: 3.14.0
Loading...
Searching...
No Matches
PTEID_CardInterfaceCallbacks Struct Reference

Public Attributes

void * context
 
PTEID_EstablishContextFn establishContext
 
PTEID_ReleaseContextFn releaseContext
 
PTEID_ListReadersFn listReaders
 
PTEID_CardPresentInReaderFn cardPresentInReader
 
PTEID_StatusWithATRFn statusWithATR
 
PTEID_ConnectFn connect
 
PTEID_DisconnectFn disconnect
 
PTEID_TransmitFn transmit
 
PTEID_RecoverFn recover
 
PTEID_ControlFn control
 
PTEID_BeginTransactionFn beginTransaction
 
PTEID_EndTransactionFn endTransaction
 

Member Data Documentation

◆ beginTransaction

PTEID_BeginTransactionFn PTEID_CardInterfaceCallbacks::beginTransaction

Function to begin a transaction

Parameters
handleCard handle
contextPointer to the context

◆ cardPresentInReader

PTEID_CardPresentInReaderFn PTEID_CardInterfaceCallbacks::cardPresentInReader

Function to check whether there is a card present in the given reader. Must not wait for card.

Parameters
csReaderName of the reader
contextPointer to the context
Returns
OK if card is present

◆ connect

PTEID_ConnectFn PTEID_CardInterfaceCallbacks::connect

Function to connect to a card

Parameters
csReaderName of the reader
outHandlePointer to receive card handle
outProtocolPointer to receive protocol used by the card
contextPointer to the context
Returns
OK if success

◆ context

void* PTEID_CardInterfaceCallbacks::context

Pointer to the user-defined context

◆ control

PTEID_ControlFn PTEID_CardInterfaceCallbacks::control

Function to use a reader-specific function specified through control code

Parameters
handleCard handle
ulControlControl code
cmdDataCommand data
cmdLengthLength of command data
respBufferBuffer to receive response
respBufferSizePointer to the size of the response buffer
ulMaxResponseSizeMaximum response size
contextPointer to the context

◆ disconnect

PTEID_DisconnectFn PTEID_CardInterfaceCallbacks::disconnect

Function to disconnect from a card

Parameters
handleCard handle
contextPointer to the context

◆ endTransaction

PTEID_EndTransactionFn PTEID_CardInterfaceCallbacks::endTransaction

Function to end a transaction

Parameters
handleCard handle
contextPointer to the context

◆ establishContext

PTEID_EstablishContextFn PTEID_CardInterfaceCallbacks::establishContext

Type definitions for PTEID Card Reader interface functions

Function to establish a context for card operations

Parameters
contextPointer to the context

◆ listReaders

PTEID_ListReadersFn PTEID_CardInterfaceCallbacks::listReaders

Function to list available card readers Reader names are listed as a multi-string structure. Card reader names are separated by a single 0x00 byte and the structure ends with 2 0x00 bytes.

Parameters
bufferPre-allocated buffer to fill with reader names
bufferSize[in/out] On input: maximum buffer size, on output: actual bytes written
contextPointer to the context

◆ recover

PTEID_RecoverFn PTEID_CardInterfaceCallbacks::recover

Function to recover a card connection

Parameters
handleCard handle
pulLockCountPointer to receive lock count
contextPointer to the context

◆ releaseContext

PTEID_ReleaseContextFn PTEID_CardInterfaceCallbacks::releaseContext

Function to release a previously established context

Parameters
contextPointer to the context

◆ statusWithATR

PTEID_StatusWithATRFn PTEID_CardInterfaceCallbacks::statusWithATR

Function to get reader status with ATR

Parameters
handleCard handle
bufferBuffer to receive ATR
bufferSizePointer to the size of the buffer
contextPointer to the context
Returns
OK if success

◆ transmit

PTEID_TransmitFn PTEID_CardInterfaceCallbacks::transmit

Function to transmit data to a card

Parameters
handleCard handle
cmdDataCommand data
cmdLengthLength of command data
responseBufferBuffer to receive response
respBufferSizePointer to the size of the response buffer
plRetValPointer to receive return value
pSendPciSend protocol control information
pRecvPciReceive protocol control information
contextPointer to the context