SmartCardEmulation Domain
Methods
- SmartCardEmulation.disable
- SmartCardEmulation.enable
- SmartCardEmulation.reportBeginTransactionResult
- SmartCardEmulation.reportConnectResult
- SmartCardEmulation.reportDataResult
- SmartCardEmulation.reportError
- SmartCardEmulation.reportEstablishContextResult
- SmartCardEmulation.reportGetStatusChangeResult
- SmartCardEmulation.reportListReadersResult
- SmartCardEmulation.reportPlainResult
- SmartCardEmulation.reportReleaseContextResult
- SmartCardEmulation.reportStatusResult
Events
- SmartCardEmulation.beginTransactionRequested
- SmartCardEmulation.cancelRequested
- SmartCardEmulation.connectRequested
- SmartCardEmulation.controlRequested
- SmartCardEmulation.disconnectRequested
- SmartCardEmulation.endTransactionRequested
- SmartCardEmulation.establishContextRequested
- SmartCardEmulation.getAttribRequested
- SmartCardEmulation.getStatusChangeRequested
- SmartCardEmulation.listReadersRequested
- SmartCardEmulation.releaseContextRequested
- SmartCardEmulation.setAttribRequested
- SmartCardEmulation.statusRequested
- SmartCardEmulation.transmitRequested
Types
Methods
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 stringSmartCardEmulation.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 stringhandle integeractiveProtocolOptional
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 stringdata stringSmartCardEmulation.reportError #
Reports an error result for the given request.
Parameters
requestId stringresultCode 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 stringcontextId integerSmartCardEmulation.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 stringreaderStates 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 stringreaders 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 stringSmartCardEmulation.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 stringSmartCardEmulation.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 stringreaderName stringstate atr stringprotocolOptional
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 stringhandle integerSmartCardEmulation.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 stringcontextId integerSmartCardEmulation.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 stringcontextId integerreader stringshareMode preferredProtocols 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 stringhandle integercontrolCode integerdata stringSmartCardEmulation.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 stringhandle integerdisposition 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 stringhandle integerdisposition 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 stringSmartCardEmulation.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 stringhandle integerattribId integerSmartCardEmulation.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 stringcontextId integerreaderStates array[ ReaderStateIn ]timeoutOptional
integerin 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 stringcontextId integerSmartCardEmulation.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 stringcontextId integerSmartCardEmulation.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 stringhandle integerattribId integerdata stringSmartCardEmulation.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 stringhandle integerSmartCardEmulation.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 stringhandle integerdata stringprotocolOptional
Types
SmartCardEmulation.ConnectionState #
Maps to |SCARD_*| connection state values.
Type: string
Allowed values: absent, present, swallowed, powered, negotiable, specific
SmartCardEmulation.Disposition #
Indicates what the reader should do with the card.
Type: string
Allowed values: leave-card, reset-card, unpower-card, eject-card
SmartCardEmulation.Protocol #
Maps to the |SCARD_PROTOCOL_*| values.
Type: string
Allowed values: t0, t1, raw
SmartCardEmulation.ProtocolSet #
Maps to the |SCARD_PROTOCOL_*| flags.
Type: object
Properties
t0Optional
booleant1Optional
booleanrawOptional
booleanSmartCardEmulation.ReaderStateFlags #
Maps to the |SCARD_STATE_*| flags.
Type: object
Properties
unawareOptional
booleanignoreOptional
booleanchangedOptional
booleanunknownOptional
booleanunavailableOptional
booleanemptyOptional
booleanpresentOptional
booleanexclusiveOptional
booleaninuseOptional
booleanmuteOptional
booleanunpoweredOptional
booleanSmartCardEmulation.ReaderStateIn #
Type: object
Properties
reader stringcurrentState currentInsertionCount integerSmartCardEmulation.ReaderStateOut #
Type: object
Properties
reader stringeventState eventCount integeratr stringSmartCardEmulation.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
Type: string
Allowed 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, unknown
SmartCardEmulation.ShareMode #
Maps to the |SCARD_SHARE_*| values.
Type: string
Allowed values: shared, exclusive, direct