ElectronicValueRW Members (POS for .NET v1.12 SDK Documentation)

2/27/2008

Defines the programmatic interface for an Electronic Value Reader/Writer (R/W) device.

The following tables list the members exposed by the ElectronicValueRW type.

Protected Constructors

	Name	Description
	ElectronicValueRW	Creates an instance of the ElectronicValueRW class.

Top

Public Fields

	Name	Description
	ExtendedErrorCenterError	Indicates that an error was returned from the approval agency.
	ExtendedErrorCommandError	Indicates that the command sent to the device is wrong.
	ExtendedErrorCommunicationError	Indicates that a communication error has occurred between the approval agency and the device.
	ExtendedErrorDailyLogOverflow	Indicates that the transaction log on the device is full.
	ExtendedErrorDeficient	Indicates that the amount cannot be subtracted because the balance is insufficient.
	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)
	ExtendedErrorLogOverflow	Indicates that the transaction log was too large to be stored.
	ExtendedErrorOverdeposit	Indicates that the device cannot add the charge because the maximum charge amount has been exceeded.
	ExtendedErrorReset	Indicates that the device was stopped during processing by the device Reset key (Stop key).
	ExtendedErrorStatistics	Indicates a specified statistic could not be reset or updated. (inherited from PosCommon)
	ExtendedErrorStatisticsDependency	(inherited from PosCommon )
	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)
	StatusCardCaptured	Indicates that the stock space sensor detects a card in the stock space.
	StatusCardDetected	Indicates that the card detection sensor detects a card in the device.
	StatusCardEntered	Indicates that the insertion slot sensor detects that a card is remaining in the slot.
	StatusLogFull	Indicates that the transaction log is full.
	StatusLogNearFull	Indicates that the transaction log is almost full.
	StatusLogOk	Indicates that the transaction log has enough capacity.
	StatusNoCard	Indicates that the card detection sensor does not detect a card.
	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)
	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
	AccountNumber	Gets information for the service provider such as the card number to specify the user (owner) information from the card.
	AdditionalSecurityInformation	Gets or sets additional security information that is stored before issuing an authorization method to an ElectronicValueRW device.
	Amount	Gets or sets the payment amount on the electronic money service.
	ApprovalCode	Gets or sets the payment approval code.
	AsyncMode	Gets or sets the Boolean value that indicates whether associated methods are performed asynchronously or synchronously.
	Balance	Gets the balance of the electronic money service.
	BalanceOfPoint	Gets the point balance on the point service.
	CapActivateService	Gets the Boolean value that indicates whether activation processing is supported.
	CapAddValue	Gets the Boolean value that indicates whether the addition of Electronic Value is supported.
	CapCancelValue	Gets the Boolean value that indicates whether the cancellation of the operation to the Electronic Value is supported.
	CapCardSensor	Gets a bitmask that indicates the types of card detection that are supported.
	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)
	CapDetectionControl	Gets information that indicates detection, ejection, or storing processes can be controlled from the application or the reader/writer.
	CapElectronicMoney	Gets the Boolean value that indicates whether the electronic money service is supported.
	CapEnumerateCardServices	Gets the Boolean value that indicates whether the enumeration of service in the card is supported.
	CapIndirectTransactionLog	Gets the Boolean value that indicates whether the transaction log is accessed as a file.
	CapLockTerminal	Gets the Boolean value that indicates whether the security lock setting is supported.
	CapLogStatus	Gets the Boolean value that indicates whether the reporting of the status of the transaction log is supported.
	CapMediumId	Gets the Boolean value that indicates whether the specification of the medium identifier is supported.
	CapPoint	Gets the Boolean value that indicates whether the point service is supported.
	CapPowerReporting	Gets the power reporting capabilities of the device. (inherited from PosCommon)
	CapStatisticsReporting	Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (inherited from PosCommon)
	CapSubtractValue	Gets the Boolean value that indicates whether the subtraction of Electronic Value is supported.
	CapTransaction	Gets the Boolean value that indicates whether the transaction mode is supported.
	CapTransactionLog	Gets the Boolean value that indicates whether the transaction log is supported.
	CapUnlockTerminal	Gets the Boolean value that indicates whether releasing of the security lock is supported.
	CapUpdateFirmware	Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (inherited from PosCommon)
	CapUpdateKey	Gets the Boolean value that indicates whether the update of key information is supported.
	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)
	CapVoucher	Gets the Boolean value that indicates whether the voucher/ticket service is supported.
	CapWriteValue	Gets the Boolean value that indicates whether the writing of Electronic Value is supported.
	CardServiceList	Gets a comma-separated (CSV) list of services supported by the card.
	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)
	CurrentService	Gets or sets the character string that identifies the currently selected service.
	DataCount	Gets a value that indicates the number of enqueued data events
	DataEventEnabled	Gets or sets the Boolean value that indicates whether the DataEvent event will be delivered to the application.
	DetectionControl	Gets or sets the Boolean value that indicates whether detection control is enabled.
	DetectionStatus	Gets or sets the Boolean value that indicates the detection status.
	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)
	ExpirationDate	Gets the expiration date.
	FreezeEvents	Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (inherited from PosCommon)
	LastUsedDate	Gets the last used date.
	LogStatus	Gets the status of the transaction log.
	MediumId	Gets or sets the medium identifier of the card.
	OutputId	Gets the ID number of the asynchronous output request that is complete.
	Point	Gets or sets the settlement point on the point service.
	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)
	ReaderWriterServiceList	Gets the comma-separated values (CSV) list of services that are supported by the Electronic Value RW device.
	SequenceNumber	Gets a "sequence number" as the result of each method call.
	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)
	SettledAmount	Gets the real amount of the settlement on the electronic money service.
	SettledPoint	Gets the settlement point on the point service.
	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)
	TransactionLog	Stores the result of the AccessLog method.
	VoucherId	Gets or sets the ID of voucher/ticket on the voucher/ticket service.
	VoucherIdList	Gets or sets the IDs of voucher/ticket that are enumerated on the voucher/ticket service.

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 the Boolean value that indicates whether the Electronic Value RW device is an exclusive-use device.

Top

Public Methods

(see also Protected Methods )

	Name	Description
	AccessLog	Gets the transaction log from the device.
	ActivateService	Executes the device activation process.
	AddValue	Adds Electronic Value on demand to the card as specified by sequenceNumber.
	BeginDetection	Executes the card detection process.
	BeginRemoval	Executes the card removal process.
	CancelValue	Cancels the Electronic Value related operation specified by SequenceNumber on demand.
	CaptureCard	The card left in the slot is removed.
	CheckHealth	(inherited from PosCommon )
	Claim	(inherited from PosCommon )
	ClearInput	Clears all buffered device input.
	ClearInputProperties	Resets the values of properties altered by the DataEvent or ErrorEvent event.
	ClearOutput	Clears all buffered device output.
	Close	Releases the device and its resources. (inherited from PosCommon)
	CompareFirmwareVersion	(inherited from PosCommon )
	DirectIO	(inherited from PosCommon )
	EndDetection	Ends the card detection process.
	EndRemoval	Ends the card removal process.
	EnumerateCardServices	Enumerates the services which are used in the card and also sets the CardServiceList property.
	Equals	Overloaded. (inherited from Object )
	GetHashCode	(inherited from Object )
	GetType	(inherited from Object )
	LockTerminal	Locks the security lock.
	Open	Opens a device for later input/output processing. (inherited from PosCommon)
	ReadValue	Reads the Electronic Value from the card.
	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 )
	SubtractValue	Subtracts the Electronic Value from the card.
	ToString	(inherited from Object )
	TransactionAccess	Enters or exits transaction mode.
	UnlockTerminal	Releases the security lock.
	UpdateFirmware	(inherited from PosCommon )
	UpdateKey	Updates the key information in the device.
	UpdateStatistic	(inherited from PosCommon )
	UpdateStatistics	Overloaded. (inherited from PosCommon )
	WriteValue	Electronic Value is added to the card as specified by SequenceNumber on demand.

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	Notifies the application about the available input data from the device.
	DirectIOEvent	Raised by the Service Object to communicate information directly to the application. (inherited from PosCommon)
	ErrorEvent	Notifies the application that an ElectronicValue R/W error has been detected and a suitable response by the application is necessary to process the error condition.
	OutputCompleteEvent	Notifies the application that the queued asynchronous output request associated with the OutputId attribute 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

See Also

Reference

ElectronicValueRW Class
Microsoft.PointOfService Namespace