PointCardRW Members
2/27/2008
Defines the programmatic interface for a UPOS Point Card Reader/Writer device.
The following tables list the members exposed by the PointCardRW type.
Protected Constructors
Name | Description | |
---|---|---|
PointCardRW | Creates an instance of the PointCardRW class. |
Top
Public Fields
Name | Description | |
---|---|---|
CharacterSetAnsi | The ANSI character set. | |
CharacterSetAscii | The ASCII character set, supporting the ASCII characters between 0x20 and 0x7F. | |
CharacterSetUnicode | The character set supports Unicode. | |
ExtendedErrorCover | Indicates the conveyance motor cover is open. | |
ExtendedErrorDisplay | Indicates a display indicator error. | |
ExtendedErrorFirmwareBadFile | Indicates the specified firmware file or files exist, but one or more of those files are either not in the correct format or are corrupted. (inherited from PosCommon) | |
ExtendedErrorJam | Indicates a card jam. | |
ExtendedErrorMotor | Indicates a conveyance motor error. | |
ExtendedErrorNoCard | Indicates there is no card in the reader. | |
ExtendedErrorPrinter | Indicates a printer error. | |
ExtendedErrorRead | Indicates a read error. | |
ExtendedErrorRelease | Indicates a card jam. | |
ExtendedErrorStatistics | Indicates a specified statistic could not be reset or updated. (inherited from PosCommon) | |
ExtendedErrorStatisticsDependency | (inherited from PosCommon ) | |
ExtendedErrorWrite | Indicates a write error. | |
StatisticCommunicationErrorCount | Holds the programmatic name of the Communication Error Count common statistic. (inherited from PosCommon) | |
StatisticDeviceCategory | Holds the programmatic name of the Device Category common statistic. (inherited from PosCommon) | |
StatisticFirmwareRevision | Holds the programmatic name of the Firmware Revision common statistic. (inherited from PosCommon) | |
StatisticHoursPoweredCount | Holds the programmatic name of the Hours Powered On common statistic. (inherited from PosCommon) | |
StatisticInstallationDate | Holds the programmatic name of the Installation Date common statistic. (inherited from PosCommon) | |
StatisticInterface | Holds the programmatic name of the Interface common statistic. (inherited from PosCommon) | |
StatisticManufactureDate | Holds the programmatic name of the Manufacture Date common statistic. (inherited from PosCommon) | |
StatisticManufacturerName | Holds the programmatic name of the Manufacturer Name common statistic. (inherited from PosCommon) | |
StatisticMechanicalRevision | Holds the programmatic name of the Mechanical Revision common statistic. (inherited from PosCommon) | |
StatisticModelName | Holds the programmatic name of the Model Name common statistic. (inherited from PosCommon) | |
StatisticSerialNumber | Holds the programmatic name of the Serial Number common statistic. (inherited from PosCommon) | |
StatisticUnifiedPOSVersion | Holds the programmatic name of the Unified POS Version common statistic. (inherited from PosCommon) | |
StatusInserted | Indicates a card is in the device. | |
StatusNoCard | Indicates no card is in the device, or the card sensor position is indeterminate. | |
StatusPowerOff | Indicates that the device’s power is turned off or it is detached from the terminal. (inherited from PosCommon) | |
StatusPowerOffline | Indicates that the device is powered on but is either not ready or unable to respond to requests. (inherited from PosCommon) | |
StatusPowerOffOffline | Indicates that either the device’s power is off or it is offline. (inherited from PosCommon) | |
StatusPowerOnline | Indicates that the device’s power is turned on and it is ready for use. (inherited from PosCommon) | |
StatusRemaining | Indicates a card remains in the entrance. | |
StatusUpdateFirmwareComplete | Indicates the update firmware process has completed successfully. (inherited from PosCommon) | |
StatusUpdateFirmwareCompleteDeviceNotRestored | Indicates the update firmware process succeeded. However, the Service Object and/or the physical device cannot be returned to the state they were in before the update firmware process started. (inherited from PosCommon) | |
StatusUpdateFirmwareFailedDeviceNeedsFirmware | Indicates the update firmware process failed. The device will not be operational until another attempt to update the firmware is successful. (inherited from PosCommon) | |
StatusUpdateFirmwareFailedDeviceOk | Indicates the update firmware process failed. However, the device is still operational. (inherited from PosCommon) | |
StatusUpdateFirmwareFailedDeviceUnknown | Indicates the update firmware process failed. The device is in an indeterminate state. (inherited from PosCommon) | |
StatusUpdateFirmwareFailedDeviceUnrecoverable | Indicates the update firmware process failed. The device is either unusable or unrecoverable through software. (inherited from PosCommon) | |
StatusUpdateFirmwareProgress | Indicates the update firmware process has completed 1 to 100 percent successfully. (inherited from PosCommon) | |
WaitForever | Used as the value for a timeout parameter in common and device-specific methods to indicate the method should wait until it receives a response, instead of timing out. (inherited from PosCommon) |
Top
Public Properties
(see also Protected Properties )
Name | Description | |
---|---|---|
CapBold | Gets a Boolean value that indicates whether the device can print bold characters. | |
CapCardEntranceSensor | Gets a Boolean value that indicates whether the device has an entrance sensor. | |
CapCharacterSet | Gets the default character set capability. | |
CapCleanCard | Gets a Boolean value that indicates whether the device supports cleaning under application control. | |
CapClearPrint | Gets a Boolean value that indicates whether the device can erase the printing area. | |
CapCompareFirmwareVersion | Gets a Boolean value that indicates whether the Service Object/device supports comparing the firmware version in the physical device against that of a firmware file. (inherited from PosCommon) | |
CapDHigh | Gets a Boolean value that indicates whether the device can print double-high characters. | |
CapDWide | Gets a Boolean value that indicates whether the device can print double-wide characters. | |
CapDWideDHigh | Gets a Boolean value that indicates whether the device can print double-high/double-width characters. | |
CapItalic | Gets a Boolean value that indicates whether the device can print italic characters. | |
CapLeft90 | Gets a Boolean value that indicates whether the device can print in rotated-90-degree-left mode. | |
CapMapCharacterSet | Gets a Boolean value that indicates whether the service object can map | |
CapPowerReporting | Gets the power reporting capabilities of the device. (inherited from PosCommon) | |
CapPrint | Gets a Boolean value that indicates whether the device has printing capability. | |
CapPrintMode | Gets a Boolean value that indicates whether the device can designate a starting position with the MapMode property. | |
CapRight90 | Gets a Boolean value that indicates the device can print in a rotated-90 degree-right mode. | |
CapRotate180 | Gets a Boolean value that indicates the device can print in a rotated upside-down mode. | |
CapStatisticsReporting | Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (inherited from PosCommon) | |
CapTracksToRead | Gets a bitmask that indicates which magnetic tracks are available. | |
CapTracksToWrite | Gets a bitmask that indicates which tracks are writable on the point card. | |
CapUpdateFirmware | Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (inherited from PosCommon) | |
CapUpdateStatistics | Gets a Boolean value that indicates whether some or all the device statistics can be reset to 0 (zero) by using the ResetStatistic and ResetStatistics methods, or updated by using the UpdateStatistic and UpdateStatistics methods. (inherited from PosCommon) | |
CardState | Gets the point card state. | |
CharacterSet | Gets or sets the character set for printing characters. | |
CharacterSetList | Gets a string of character set numbers. | |
CheckHealthText | Gets a string that indicates the health of the device. (inherited from PosCommon) | |
Claimed | Gets a Boolean value that indicates whether the device is claimed for exclusive access. (inherited from PosCommon) | |
Compatibility | Gets the compatibility level of a device. (inherited from PosDevice) | |
DataCount | Gets the number of currently queued data events. | |
DataEventEnabled | Gets or sets a Boolean value that indicates whether a DataEvent event is delivered when input data is queued. | |
DeviceDescription | Gets a string identifying the device and the company that manufactured it. (inherited from PosCommon) | |
DeviceEnabled | Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. (inherited from PosCommon) | |
DeviceName | Gets a short string identifying the device and any pertinent information about it. (inherited from PosCommon) | |
FontTypefaceList | Gets the fonts and typefaces supported by the point card reader/writer. | |
FreezeEvents | Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (inherited from PosCommon) | |
LineChars | Gets or sets the number of characters that can be printed on a line on the point card reader/writer. | |
LineCharsList | Gets the line character widths supported by the point card reader/writer. | |
LineHeight | Gets or sets the point card reader/writer print line height. | |
LineSpacing | Gets or sets the spacing of each single-high print line. This includes both the printed line height plus the white space between each pair of lines. | |
LineWidth | Gets the width of a line of LineChars characters. | |
MapCharacterSet | Gets or sets a Boolean value that indicates whether characters are mapped from the application to the set specified in the CharacterSetproperty. | |
MapMode | Gets or sets the mapping mode of the point card reader/writer. | |
MaxLine | Gets the maximum printable line number. | |
OutputId | Gets a unique output request ID. | |
PowerNotify | Gets or sets the type of power notification selection made by the application. (inherited from PosCommon) | |
PowerState | Gets the current power condition. (inherited from PosCommon) | |
PrintHeight | Gets the height of the largest character in a character set. | |
ReadState | Gets read state information for Track1 through Track6. | |
RecvLength | Gets length information for Track1 through Track6. | |
ServiceObjectDescription | Gets a string identifying the Service Object that supports the device and the company that produced it. (inherited from PosCommon) | |
ServiceObjectVersion | Gets the Service Object version number. (inherited from PosCommon) | |
SidewaysMaxChars | Gets the maximum number of characters that can be printed on each line in sideways mode. | |
SidewaysMaxLines | Gets the maximum number of lines that can be printed in sideways mode. | |
State | Gets the current state of the device. (inherited from PosCommon) | |
SynchronizingObject | Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (inherited from PosCommon) | |
Track1Data | Gets the Track1 data from the point card. | |
Track2Data | Gets the Track2 data from the point card. | |
Track3Data | Gets the Track3 data from the point card. | |
Track4Data | Gets the Track4 data from the point card. | |
Track5Data | Gets the Track5 data from the point card. | |
Track6Data | Gets the Track6 data from the point card. | |
TracksToRead | Gets or sets the tracks to read from the point card. | |
TracksToWrite | Gets or sets the tracks to write to the point card. | |
Write1Data | Gets or sets the data PrintWrite uses to write to Track1. | |
Write2Data | Gets or sets the data PrintWrite uses to write to Track2. | |
Write3Data | Gets or sets the data PrintWrite uses to write to Track3. | |
Write4Data | Gets or sets the data PrintWrite uses to write to Track4. | |
Write5Data | Gets or sets the data PrintWrite uses to write to Track5. | |
Write6Data | Gets or sets the data PrintWrite uses to write to Track6. | |
WriteState | Gets write state information for Track1 through Track6. |
Top
Protected Properties
Name | Description | |
---|---|---|
DeviceInstanceId | (inherited from PosCommon ) | |
DevicePath | Gets or sets the hardware path of a device. (inherited from PosCommon) | |
HardwareId | (inherited from PosCommon ) | |
IsExclusiveUseDevice | Overridden. Gets a Boolean value that indicates whether the PointCardRW is an exclusive-use device. |
Top
Public Methods
(see also Protected Methods )
Name | Description | |
---|---|---|
BeginInsertion | Starts point card processing. | |
BeginRemoval | Starts point card removal processing. | |
CheckHealth | (inherited from PosCommon ) | |
Claim | (inherited from PosCommon ) | |
CleanCard | Cleans the read/write heads of the point card reader/writer. | |
ClearInput | Clears all buffered device input. | |
ClearInputProperties | Resets the values of properties altered by DataEvent or ErrorEvent. | |
ClearOutput | Clears all buffered output data. This includes all asynchronous output. | |
ClearPrintWrite | Erases the printing area of a point card and erases the magnetic track data on a point card or erases the magnetic track data on a point card. | |
Close | Releases the device and its resources. (inherited from PosCommon) | |
CompareFirmwareVersion | (inherited from PosCommon ) | |
DirectIO | (inherited from PosCommon ) | |
EndInsertion | Ends point card insertion processing. | |
EndRemoval | Ends point card removal processing. | |
Equals | Overloaded. (inherited from Object ) | |
GetHashCode | (inherited from Object ) | |
GetType | (inherited from Object ) | |
Open | Opens a device for later input/output processing. (inherited from PosCommon) | |
PrintWrite | Prints the specified data on the printing area of the point card, writes data from the WriteXData properties to the magnetic tracks, or both. | |
ReferenceEquals | (inherited from Object ) | |
Release | Releases exclusive access to the device. (inherited from PosCommon) | |
ResetStatistic | (inherited from PosCommon ) | |
ResetStatistics | Overloaded. (inherited from PosCommon ) | |
RetrieveStatistic | (inherited from PosCommon ) | |
RetrieveStatistics | Overloaded. (inherited from PosCommon ) | |
RotatePrint | Enters or exits rotated print mode. | |
ToString | (inherited from Object ) | |
UpdateFirmware | (inherited from PosCommon ) | |
UpdateStatistic | (inherited from PosCommon ) | |
UpdateStatistics | Overloaded. (inherited from PosCommon ) | |
ValidateData | Determines whether a data sequence, possibly including one or more escape sequences, is valid for the specified station, before it calls the PrintWrite method. |
Top
Protected Methods
Name | Description | |
---|---|---|
DeleteConfigurationProperty | (inherited from PosCommon ) | |
Finalize | (inherited from Object ) | |
GetConfigurationProperty | (inherited from PosCommon ) | |
Invoke | (inherited from PosCommon ) | |
MemberwiseClone | (inherited from Object ) | |
SetConfigurationProperty | (inherited from PosCommon ) |
Top
Public Events
(see also Protected Events )
Name | Description | |
---|---|---|
DataEvent | Raised by the service object to notify the application that input data is available from the device. | |
DirectIOEvent | Raised by the Service Object to communicate information directly to the application. (inherited from PosCommon) | |
ErrorEvent | Raised by the service object to notify the application that a point card error has been detected and a suitable response by the application is necessary to process the error condition. | |
OutputCompleteEvent | Raised by the service object to notify the application that the queued output request associated with the OutputId property has completed successfully. | |
StatusUpdateEvent | Raised by the Service Object to alert the application of a device status change. (inherited from PosCommon) |
Top
Protected Events
Name | Description | |
---|---|---|
DeviceAddedEvent | (inherited from PosCommon ) | |
DeviceRemovedEvent | (inherited from PosCommon ) |
Top