Inheritance diagram for HidGlobal.OK.Readers.IContextHandler:

Public Member Functions
void	Establish (Scope scope)
	Establish context handle for winscard resource manager. More...

void	Release ()
	Release context handle established by Establish(Scope). More...

void	ReEstablish ()
	Establish context handle with Scope used in previous call of Establish(Scope). More...

bool	IsValid ()
	Check if curently held context handle is valid. More...

IReadOnlyList< string >	ListReaders (IReadOnlyList< string > readerGroups)
	Lists readers within given reader groups. More...

IReadOnlyList< string >	ListReaders ()
	List all available readers. More...

IReadOnlyList< string >	ListReaderGroups ()
	List reader groups existing in the system. More...

void	IntroduceReaderGroup (string groupName)
	Introduce new reader group to the smart card resource manager. More...

void	ForgetReaderGroup (string groupName)
	Deletes reader group from smart card resource manager. More...

void	IntroduceReader (string readerName, string deviceName)
	Introduce additional alias of given device to the smart card resource manager. More...

void	ForgetReader (string readerName)
	Removes reader from the smart card resource manager. More...

void	AddReaderToGroup (string readerName, string groupName)
	Add specified reader to the reader group. Group need to be introduced by IntroduceReaderGroup(string) beforehand. More...

void	RemoveReaderFromGroup (string readerName, string groupName)
	Removes reader form the group. More...

void	Cancel ()
	Cancel blocking request of GetStatusChange(int,ReaderState[]). More...

IReadOnlyList< ReaderState >	GetStatusChange (int timeout, IReadOnlyList< ReaderState > readerStates)

IReadOnlyList< ReaderState >	GetReaderState (IReadOnlyDictionary< string, ReaderStates > readerNamesWithStatesDictionary)

ReaderState	GetReaderState (string reader, ReaderStates stateOfTheReader)

Properties
IntPtr	Handle `[get]`
	Retrives the context handle. More...

Member Function Documentation

◆ AddReaderToGroup()

void HidGlobal.OK.Readers.IContextHandler.AddReaderToGroup	(	string	readerName,
		string	groupName
	)

Add specified reader to the reader group. Group need to be introduced by IntroduceReaderGroup(string) beforehand.

Parameters

readerName	Name of the reader.
groupName	Name of the group.

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ Cancel()

void HidGlobal.OK.Readers.IContextHandler.Cancel ( )

Cancel blocking request of GetStatusChange(int,ReaderState[]).

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ Establish()

void HidGlobal.OK.Readers.IContextHandler.Establish ( Scope scope )

Establish context handle for winscard resource manager.

Parameters

scope Defines for the scope input parameter of SCardEstablishContext

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ ForgetReader()

void HidGlobal.OK.Readers.IContextHandler.ForgetReader ( string readerName )

Removes reader from the smart card resource manager.

Parameters

readerName Name of the reader.

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ ForgetReaderGroup()

void HidGlobal.OK.Readers.IContextHandler.ForgetReaderGroup ( string groupName )

Deletes reader group from smart card resource manager.

Parameters

groupName Name of the reader group.

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ GetReaderState() [1/2]

IReadOnlyList<ReaderState> HidGlobal.OK.Readers.IContextHandler.GetReaderState ( IReadOnlyDictionary< string, ReaderStates > readerNamesWithStatesDictionary )

Parameters

readerNamesWithStatesDictionary Dictionary key is PCSC reader name returned by SCardListReaders(), value is actual reader state ReaderStates known by application.

Returns: ReaderState

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ GetReaderState() [2/2]

ReaderState HidGlobal.OK.Readers.IContextHandler.GetReaderState	(	string	reader,
		ReaderStates	stateOfTheReader
	)

Parameters

reader	PCSC reader name returned by SCardListReaders().
stateOfTheReader	actual reader state ReaderStates known by application.

Returns: ReaderState

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ GetStatusChange()

IReadOnlyList<ReaderState> HidGlobal.OK.Readers.IContextHandler.GetStatusChange	(	int	timeout,
		IReadOnlyList< ReaderState >	readerStates
	)

Parameters

timeout
readerStates

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ IntroduceReader()

void HidGlobal.OK.Readers.IContextHandler.IntroduceReader	(	string	readerName,
		string	deviceName
	)

Introduce additional alias of given device to the smart card resource manager.

Parameters

readerName	Additional name for the device.
deviceName	Name of the device.

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ IntroduceReaderGroup()

void HidGlobal.OK.Readers.IContextHandler.IntroduceReaderGroup ( string groupName )

Introduce new reader group to the smart card resource manager.

Reader group will be created only after additon of first reader to it.

Parameters

groupName Name of the reader group.

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ IsValid()

bool HidGlobal.OK.Readers.IContextHandler.IsValid ( )

Check if curently held context handle is valid.

Returns: True if context handle is valid, false otherwise.

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ ListReaderGroups()

IReadOnlyList<string> HidGlobal.OK.Readers.IContextHandler.ListReaderGroups ( )

List reader groups existing in the system.

Returns: String array with names of available reader groups.

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ ListReaders() [1/2]

IReadOnlyList<string> HidGlobal.OK.Readers.IContextHandler.ListReaders ( IReadOnlyList< string > readerGroups )

Lists readers within given reader groups.

Parameters

readerGroups Names of the reader groups

Returns: String array with names of active readers.

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ ListReaders() [2/2]

IReadOnlyList<string> HidGlobal.OK.Readers.IContextHandler.ListReaders ( )

List all available readers.

Returns: String array with names of active readers.

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ ReEstablish()

void HidGlobal.OK.Readers.IContextHandler.ReEstablish ( )

Establish context handle with Scope used in previous call of Establish(Scope).

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ Release()

void HidGlobal.OK.Readers.IContextHandler.Release ( )

Release context handle established by Establish(Scope).

Implemented in HidGlobal.OK.Readers.ContextHandler.

◆ RemoveReaderFromGroup()

void HidGlobal.OK.Readers.IContextHandler.RemoveReaderFromGroup	(	string	readerName,
		string	groupName
	)

Removes reader form the group.

Parameters

readerName	Name of the reader.
groupName	Name of the group.

Implemented in HidGlobal.OK.Readers.ContextHandler.

Property Documentation

◆ Handle

IntPtr HidGlobal.OK.Readers.IContextHandler.Handle

get

Retrives the context handle.

The documentation for this interface was generated from the following file:

C:/Jenkins/workspace/Samples/SampleCodes/SampleCodes/HidGlobal.OK.Readers/IContextHandler.cs

Public Member Functions

Properties

Member Function Documentation

◆ AddReaderToGroup()

◆ Cancel()

◆ Establish()

◆ ForgetReader()

◆ ForgetReaderGroup()

◆ GetReaderState() [1/2]

◆ GetReaderState() [2/2]

◆ GetStatusChange()

◆ IntroduceReader()

◆ IntroduceReaderGroup()

◆ IsValid()

◆ ListReaderGroups()

◆ ListReaders() [1/2]

◆ ListReaders() [2/2]

◆ ReEstablish()

◆ Release()

◆ RemoveReaderFromGroup()

Property Documentation

◆ Handle