Table of Contents

Interface ISmartCardEmulation

Namespace
Selenium.WebDriver.BiDi.Cdp.SmartCardEmulation
Assembly
Selenium.WebDriver.BiDi.Cdp.dll
[Experimental("BIDICDP001")]
public interface ISmartCardEmulation

Properties

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

IEventSource<BeginTransactionRequestedEventArgs> BeginTransactionRequested { get; }

Property Value

IEventSource<BeginTransactionRequestedEventArgs>

Remarks

Event args (BeginTransactionRequestedEventArgs):

  • RequestId
  • Handle

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

IEventSource<CancelRequestedEventArgs> CancelRequested { get; }

Property Value

IEventSource<CancelRequestedEventArgs>

Remarks

Event args (CancelRequestedEventArgs):

  • RequestId
  • ContextId

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

IEventSource<ConnectRequestedEventArgs> ConnectRequested { get; }

Property Value

IEventSource<ConnectRequestedEventArgs>

Remarks

Event args (ConnectRequestedEventArgs):

  • RequestId
  • ContextId
  • Reader
  • ShareMode
  • PreferredProtocols

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

IEventSource<ControlRequestedEventArgs> ControlRequested { get; }

Property Value

IEventSource<ControlRequestedEventArgs>

Remarks

Event args (ControlRequestedEventArgs):

  • RequestId
  • Handle
  • ControlCode
  • Data

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

IEventSource<DisconnectRequestedEventArgs> DisconnectRequested { get; }

Property Value

IEventSource<DisconnectRequestedEventArgs>

Remarks

Event args (DisconnectRequestedEventArgs):

  • RequestId
  • Handle
  • Disposition

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

IEventSource<EndTransactionRequestedEventArgs> EndTransactionRequested { get; }

Property Value

IEventSource<EndTransactionRequestedEventArgs>

Remarks

Event args (EndTransactionRequestedEventArgs):

  • RequestId
  • Handle
  • Disposition

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

IEventSource<EstablishContextRequestedEventArgs> EstablishContextRequested { get; }

Property Value

IEventSource<EstablishContextRequestedEventArgs>

Remarks

Event args (EstablishContextRequestedEventArgs):

  • RequestId

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

IEventSource<GetAttribRequestedEventArgs> GetAttribRequested { get; }

Property Value

IEventSource<GetAttribRequestedEventArgs>

Remarks

Event args (GetAttribRequestedEventArgs):

  • RequestId
  • Handle
  • AttribId

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

IEventSource<GetStatusChangeRequestedEventArgs> GetStatusChangeRequested { get; }

Property Value

IEventSource<GetStatusChangeRequestedEventArgs>

Remarks

Event args (GetStatusChangeRequestedEventArgs):

  • RequestId
  • ContextId
  • ReaderStates
  • Timeout - in milliseconds, if absent, it means "infinite"

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

IEventSource<ListReadersRequestedEventArgs> ListReadersRequested { get; }

Property Value

IEventSource<ListReadersRequestedEventArgs>

Remarks

Event args (ListReadersRequestedEventArgs):

  • RequestId
  • ContextId

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

IEventSource<ReleaseContextRequestedEventArgs> ReleaseContextRequested { get; }

Property Value

IEventSource<ReleaseContextRequestedEventArgs>

Remarks

Event args (ReleaseContextRequestedEventArgs):

  • RequestId
  • ContextId

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

IEventSource<SetAttribRequestedEventArgs> SetAttribRequested { get; }

Property Value

IEventSource<SetAttribRequestedEventArgs>

Remarks

Event args (SetAttribRequestedEventArgs):

  • RequestId
  • Handle
  • AttribId
  • Data

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

IEventSource<StatusRequestedEventArgs> StatusRequested { get; }

Property Value

IEventSource<StatusRequestedEventArgs>

Remarks

Event args (StatusRequestedEventArgs):

  • RequestId
  • Handle

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

IEventSource<TransmitRequestedEventArgs> TransmitRequested { get; }

Property Value

IEventSource<TransmitRequestedEventArgs>

Remarks

Event args (TransmitRequestedEventArgs):

  • RequestId
  • Handle
  • Data
  • Protocol

Methods

DisableAsync(string?, CancellationToken)

Disables the |SmartCardEmulation| domain.

Task<DisableResult> DisableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<DisableResult>

A task representing the asynchronous operation, containing a DisableResult.

EnableAsync(string?, CancellationToken)

Enables the |SmartCardEmulation| domain.

Task<EnableResult> EnableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<EnableResult>

A task representing the asynchronous operation, containing a EnableResult.

ReportBeginTransactionResultAsync(string, long, string?, CancellationToken)

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

Task<ReportBeginTransactionResultResult> ReportBeginTransactionResultAsync(string requestId, long handle, string? session = null, CancellationToken cancellationToken = default)

Parameters

requestId string
handle long
session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ReportBeginTransactionResultResult>

A task representing the asynchronous operation, containing a ReportBeginTransactionResultResult.

ReportConnectResultAsync(string, long, Protocol?, string?, CancellationToken)

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

Task<ReportConnectResultResult> ReportConnectResultAsync(string requestId, long handle, Protocol? activeProtocol = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

requestId string
handle long
activeProtocol Protocol?
session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ReportConnectResultResult>

A task representing the asynchronous operation, containing a ReportConnectResultResult.

ReportDataResultAsync(string, string, string?, CancellationToken)

Reports the successful result of a call that sends back data on success. Used for |SCardTransmit|, |SCardControl|, and |SCardGetAttrib|.

This maps to:

  1. 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

  2. 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

  3. 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

Task<ReportDataResultResult> ReportDataResultAsync(string requestId, string data, string? session = null, CancellationToken cancellationToken = default)

Parameters

requestId string
data string
session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ReportDataResultResult>

A task representing the asynchronous operation, containing a ReportDataResultResult.

ReportErrorAsync(string, ResultCode, string?, CancellationToken)

Reports an error result for the given request.

Task<ReportErrorResult> ReportErrorAsync(string requestId, ResultCode resultCode, string? session = null, CancellationToken cancellationToken = default)

Parameters

requestId string
resultCode ResultCode
session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ReportErrorResult>

A task representing the asynchronous operation, containing a ReportErrorResult.

ReportEstablishContextResultAsync(string, long, string?, CancellationToken)

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

Task<ReportEstablishContextResultResult> ReportEstablishContextResultAsync(string requestId, long contextId, string? session = null, CancellationToken cancellationToken = default)

Parameters

requestId string
contextId long
session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ReportEstablishContextResultResult>

A task representing the asynchronous operation, containing a ReportEstablishContextResultResult.

ReportGetStatusChangeResultAsync(string, ImmutableArray<ReaderStateOut>, string?, CancellationToken)

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

Task<ReportGetStatusChangeResultResult> ReportGetStatusChangeResultAsync(string requestId, ImmutableArray<ReaderStateOut> readerStates, string? session = null, CancellationToken cancellationToken = default)

Parameters

requestId string
readerStates ImmutableArray<ReaderStateOut>
session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ReportGetStatusChangeResultResult>

A task representing the asynchronous operation, containing a ReportGetStatusChangeResultResult.

ReportListReadersResultAsync(string, ImmutableArray<string>, string?, CancellationToken)

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

Task<ReportListReadersResultResult> ReportListReadersResultAsync(string requestId, ImmutableArray<string> readers, string? session = null, CancellationToken cancellationToken = default)

Parameters

requestId string
readers ImmutableArray<string>
session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ReportListReadersResultResult>

A task representing the asynchronous operation, containing a ReportListReadersResultResult.

ReportPlainResultAsync(string, string?, CancellationToken)

Reports the successful result of a call that returns only a result code. Used for: |SCardCancel|, |SCardDisconnect|, |SCardSetAttrib|, |SCardEndTransaction|.

This maps to:

  1. 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

  2. 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

  3. 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

  4. 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

Task<ReportPlainResultResult> ReportPlainResultAsync(string requestId, string? session = null, CancellationToken cancellationToken = default)

Parameters

requestId string
session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ReportPlainResultResult>

A task representing the asynchronous operation, containing a ReportPlainResultResult.

ReportReleaseContextResultAsync(string, string?, CancellationToken)

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

Task<ReportReleaseContextResultResult> ReportReleaseContextResultAsync(string requestId, string? session = null, CancellationToken cancellationToken = default)

Parameters

requestId string
session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ReportReleaseContextResultResult>

A task representing the asynchronous operation, containing a ReportReleaseContextResultResult.

ReportStatusResultAsync(string, string, ConnectionState, string, Protocol?, string?, CancellationToken)

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

Task<ReportStatusResultResult> ReportStatusResultAsync(string requestId, string readerName, ConnectionState state, string atr, Protocol? protocol = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

requestId string
readerName string
state ConnectionState
atr string
protocol Protocol?
session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ReportStatusResultResult>

A task representing the asynchronous operation, containing a ReportStatusResultResult.

Edit this page