SmartCardEmulation Domain
Methods
Events
Types
Methods
SmartCardEmulation.disable #
Disables the |SmartCardEmulation| domain.
SmartCardEmulation.enable #
Enables the |SmartCardEmulation| domain.
SmartCardEmulation.reportBeginTransactionResult #
Reports the result of a |SCardBeginTransaction| call. On success, this creates a new transaction object.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaddb835dce01a0da1d6ca02d33ee7d861 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardbegintransaction
parameters
- requestId
-
string
- handle
-
integer
SmartCardEmulation.reportConnectResult #
Reports the successful result of a |SCardConnect| call.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4e515829752e0a8dbc4d630696a8d6a5 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardconnecta
parameters
- requestId
-
string
- handle
-
integer
- activeProtocol
-
Protocol
SmartCardEmulation.reportDataResult #
Reports the successful result of a call that sends back data on success. Used for |SCardTransmit|, |SCardControl|, and |SCardGetAttrib|.
This maps to:
SCardTransmit PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga9a2d77242a271310269065e64633ab99 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardtransmit
SCardControl PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gac3454d4657110fd7f753b2d3d8f4e32f Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcontrol
SCardGetAttrib PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacfec51917255b7a25b94c5104961602 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetattrib
parameters
- requestId
-
string
- data
-
string
SmartCardEmulation.reportError #
Reports an error result for the given request.
parameters
- requestId
-
string
- resultCode
-
ResultCode
SmartCardEmulation.reportEstablishContextResult #
Reports the successful result of a |SCardEstablishContext| call.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaa1b8970169fd4883a6dc4a8f43f19b67 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardestablishcontext
parameters
- requestId
-
string
- contextId
-
integer
SmartCardEmulation.reportGetStatusChangeResult #
Reports the successful result of a |SCardGetStatusChange| call.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga33247d5d1257d59e55647c3bb717db24 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetstatuschangea
parameters
- requestId
-
string
- readerStates
-
array[ ReaderStateOut ]
SmartCardEmulation.reportListReadersResult #
Reports the successful result of a |SCardListReaders| call.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga93b07815789b3cf2629d439ecf20f0d9 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardlistreadersa
parameters
- requestId
-
string
- readers
-
array[ string ]
SmartCardEmulation.reportPlainResult #
Reports the successful result of a call that returns only a result code. Used for: |SCardCancel|, |SCardDisconnect|, |SCardSetAttrib|, |SCardEndTransaction|.
This maps to:
SCardCancel PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacbbc0c6d6c0cbbeb4f4debf6fbeeee6 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcancel
SCardDisconnect PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4be198045c73ec0deb79e66c0ca1738a Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scarddisconnect
SCardSetAttrib PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga060f0038a4ddfd5dd2b8fadf3c3a2e4f Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardsetattrib
SCardEndTransaction PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae8742473b404363e5c587f570d7e2f3b Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardendtransaction
parameters
- requestId
-
string
SmartCardEmulation.reportReleaseContextResult #
Reports the successful result of a |SCardReleaseContext| call.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga6aabcba7744c5c9419fdd6404f73a934 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardreleasecontext
parameters
- requestId
-
string
SmartCardEmulation.reportStatusResult #
Reports the successful result of a |SCardStatus| call.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae49c3c894ad7ac12a5b896bde70d0382 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardstatusa
parameters
- requestId
-
string
- readerName
-
string
- state
-
ConnectionState
- atr
-
string
- protocol
-
Protocol
Events
SmartCardEmulation.beginTransactionRequested #
Fired when |SCardBeginTransaction| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaddb835dce01a0da1d6ca02d33ee7d861 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardbegintransaction
parameters
- requestId
-
string
- handle
-
integer
SmartCardEmulation.cancelRequested #
Fired when |SCardCancel| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacbbc0c6d6c0cbbeb4f4debf6fbeeee6 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcancel
parameters
- requestId
-
string
- contextId
-
integer
SmartCardEmulation.connectRequested #
Fired when |SCardConnect| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4e515829752e0a8dbc4d630696a8d6a5 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardconnecta
parameters
- requestId
-
string
- contextId
-
integer
- reader
-
string
- shareMode
-
ShareMode
- preferredProtocols
-
ProtocolSet
SmartCardEmulation.controlRequested #
Fired when |SCardControl| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gac3454d4657110fd7f753b2d3d8f4e32f Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcontrol
parameters
- requestId
-
string
- handle
-
integer
- controlCode
-
integer
- data
-
string
SmartCardEmulation.disconnectRequested #
Fired when |SCardDisconnect| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4be198045c73ec0deb79e66c0ca1738a Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scarddisconnect
parameters
- requestId
-
string
- handle
-
integer
- disposition
-
Disposition
SmartCardEmulation.endTransactionRequested #
Fired when |SCardEndTransaction| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae8742473b404363e5c587f570d7e2f3b Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardendtransaction
parameters
- requestId
-
string
- handle
-
integer
- disposition
-
Disposition
SmartCardEmulation.establishContextRequested #
Fired when |SCardEstablishContext| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaa1b8970169fd4883a6dc4a8f43f19b67 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardestablishcontext
parameters
- requestId
-
string
SmartCardEmulation.getAttribRequested #
Fired when |SCardGetAttrib| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacfec51917255b7a25b94c5104961602 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetattrib
parameters
- requestId
-
string
- handle
-
integer
- attribId
-
integer
SmartCardEmulation.getStatusChangeRequested #
Fired when |SCardGetStatusChange| is called. Timeout is specified in milliseconds.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga33247d5d1257d59e55647c3bb717db24 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetstatuschangea
parameters
- requestId
-
string
- contextId
-
integer
- readerStates
-
array[ ReaderStateIn ]
- timeout
-
integer
in milliseconds, if absent, it means "infinite"
SmartCardEmulation.listReadersRequested #
Fired when |SCardListReaders| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga93b07815789b3cf2629d439ecf20f0d9 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardlistreadersa
parameters
- requestId
-
string
- contextId
-
integer
SmartCardEmulation.releaseContextRequested #
Fired when |SCardReleaseContext| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga6aabcba7744c5c9419fdd6404f73a934 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardreleasecontext
parameters
- requestId
-
string
- contextId
-
integer
SmartCardEmulation.setAttribRequested #
Fired when |SCardSetAttrib| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga060f0038a4ddfd5dd2b8fadf3c3a2e4f Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardsetattrib
parameters
- requestId
-
string
- handle
-
integer
- attribId
-
integer
- data
-
string
SmartCardEmulation.statusRequested #
Fired when |SCardStatus| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae49c3c894ad7ac12a5b896bde70d0382 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardstatusa
parameters
- requestId
-
string
- handle
-
integer
SmartCardEmulation.transmitRequested #
Fired when |SCardTransmit| is called.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga9a2d77242a271310269065e64633ab99 Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardtransmit
parameters
- requestId
-
string
- handle
-
integer
- data
-
string
- protocol
-
Protocol
Types
SmartCardEmulation.ConnectionState #
Maps to |SCARD_*| connection state values.
absent, present, swallowed, powered, negotiable, specificType: string
SmartCardEmulation.Disposition #
Indicates what the reader should do with the card.
leave-card, reset-card, unpower-card, eject-cardType: string
SmartCardEmulation.Protocol #
Maps to the |SCARD_PROTOCOL_*| values.
t0, t1, rawType: string
SmartCardEmulation.ProtocolSet #
Maps to the |SCARD_PROTOCOL_*| flags.
Type: object
properties
- t0
-
boolean
- t1
-
boolean
- raw
-
boolean
SmartCardEmulation.ReaderStateFlags #
Maps to the |SCARD_STATE_*| flags.
Type: object
properties
- unaware
-
boolean
- ignore
-
boolean
- changed
-
boolean
- unknown
-
boolean
- unavailable
-
boolean
- empty
-
boolean
- present
-
boolean
- exclusive
-
boolean
- inuse
-
boolean
- mute
-
boolean
- unpowered
-
boolean
SmartCardEmulation.ReaderStateIn #
Type: object
properties
- reader
-
string
- currentState
-
ReaderStateFlags
- currentInsertionCount
-
integer
SmartCardEmulation.ReaderStateOut #
Type: object
properties
- reader
-
string
- eventState
-
ReaderStateFlags
- eventCount
-
integer
- atr
-
string
SmartCardEmulation.ResultCode #
Indicates the PC/SC error code.
This maps to: PC/SC Lite: https://pcsclite.apdu.fr/api/group__ErrorCodes.html Microsoft: https://learn.microsoft.com/en-us/windows/win32/secauthn/authentication-return-values
success, removed-card, reset-card, unpowered-card, unresponsive-card, unsupported-card, reader-unavailable, sharing-violation, not-transacted, no-smartcard, proto-mismatch, system-cancelled, not-ready, cancelled, insufficient-buffer, invalid-handle, invalid-parameter, invalid-value, no-memory, timeout, unknown-reader, unsupported-feature, no-readers-available, service-stopped, no-service, comm-error, internal-error, server-too-busy, unexpected, shutdown, unknown-card, unknownType: string
SmartCardEmulation.ShareMode #
Maps to the |SCARD_SHARE_*| values.
shared, exclusive, directType: string