Show / Hide Table of Contents

Class Reader

Class represents a smart card reader (either a physical, hardware reader, or a virtual smart card).

Inheritance
System.Object
Reader
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: scmapi
Assembly: scmapi.dll
Syntax
public class Reader

Methods

Connect()

Connects to the token inserted in the reader. This method succeeds only if the card is supported by the middleware.

Declaration
public Token Connect()
Returns
Type Description
Token

the Token object connected to the reader.

GetName()

Gets the name of the reader.

Declaration
public string GetName()
Returns
Type Description
System.String

the name of the reader.

GetStatus()

Gets the status of the reader as a Status enum. The following status can be returned:

  • UNAVAILABLE
  • MUTE
  • EXCLUSIVE
  • OK
Declaration
public Status GetStatus()
Returns
Type Description
Status

the status of the reader.

IsCardPresent()

Returns true if the card is inserted in the reader.

Declaration
public bool IsCardPresent()
Returns
Type Description
System.Boolean

true if the card is inserted in the reader; otherwise, false.

IsDongle()

Returns true if the reader is known as an USB dongle type (as opposed to a standard ID-1 format card reader).

Note: that this is indicative, and based on an internal registry of reader names.

Declaration
public bool IsDongle()
Returns
Type Description
System.Boolean

true if the reader is known as un USB dongle type; otherwise, false.

IsVirtual()

Returns Returns true if the reader is a virtual smart card.

Declaration
public bool IsVirtual()
Returns
Type Description
System.Boolean

true if the reader is a virtual smart card; otherwise, false.

Back to top Generated by DocFX