ElectronicJournal Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines the programmatic interface for an Electronic Journal device.
public abstract class ElectronicJournal : Microsoft.PointOfService.PosCommontype ElectronicJournal = class
inherit PosCommonPublic MustInherit Class ElectronicJournal
Inherits PosCommon- Inheritance
- Derived
Constructors
| ElectronicJournal() |
Creates an instance of the ElectronicJournal class. |
Fields
| ExtendedErrorCorruptedMedium |
Indicates that the medium is corrupted. |
| ExtendedErrorExisting |
Indicates that the marker name is already specified in the medium. |
| 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) |
| ExtendedErrorMediumFull |
Holds a value that indicates that the medium is full. |
| ExtendedErrorMultipleMarker |
Indicates that more than one marker exists for the specified time period. |
| ExtendedErrorMultipleMarkers |
Indicates that, although multiple markers were requested, only one can be returned. |
| ExtendedErrorNotEnoughSpace |
Indicates that there is insufficient free space. |
| ExtendedErrorStatistics |
Indicates a specified statistic could not be reset or updated. (Inherited from PosCommon) |
| ExtendedErrorStatisticsDependency | (Inherited from PosCommon) |
| ExtendedErrorUninitializedMedium |
Indicates that the medium is not initialized. |
| ExtendedErrorUnknownDataFormat |
Indicates that the medium has an unknown or unsupported data format. |
| 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) |
| StatisticEraseCount |
Indicates the number of times the medium has been erased. |
| StatisticFailedWriteCount |
Holds the number of failed write operations. |
| 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) |
| StatisticMediumFreeSpace |
Holds a value that indicates the free space on the medium. |
| StatisticMediumRemovedCount |
Indicates the number of times the medium is removed. |
| StatisticMediumSize |
Indicates the medium size. |
| 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) |
| StatisticWriteCount |
Indicates the number of write operations that are performed on the medium. |
| StatusIdle | |
| StatusMediumFull |
Holds a value that indicates that the medium is full. |
| StatusMediumInserted |
Holds a value that indicates that the medium is currently inserted. |
| StatusMediumNearFull |
Holds a value that indicates that the medium is almost full. |
| StatusMediumRemoved |
Holds a value that indicates that the medium has been removed. |
| StatusMediumSuspended |
Holds a value that indicates that the medium is suspended. |
| 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) |
Properties
| AsyncMode |
Gets or sets the Boolean value that indicates whether the print methods are performed asynchronously. |
| AutoDisable |
Gets or sets the Boolean value that indicates whether POS for .NET automatically disables the device when data is received. |
| CapAddMarker |
Gets the Boolean value that indicates whether the application can use the AddMarker(String) method. |
| 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) |
| CapErasableMedium |
Gets the Boolean value that indicates whether the storage medium can be erased. |
| CapInitializeMedium |
Gets the Boolean value that indicates whether the application can initialize the medium. |
| CapMediumIsAvailable |
Gets the Boolean value that indicates whether the application can search for a connected recording medium. |
| CapPowerReporting |
Gets the power reporting capabilities of the device. (Inherited from PosCommon) |
| CapPrintContent |
Gets the Boolean value that indicates whether the device can reprint stored journal documents on a connected printer. |
| CapPrintContentFile |
Gets the Boolean value that indicates whether journal documents that are extracted from the storage medium can be printed on a connected printing device. |
| CapRetrieveCurrentMarker |
Gets the Boolean value that indicates whether the application can use the Microsoft.PointOfService.ElectronicJournal.RetrieveCurrentMarker(PointOfService.MarkerType) method. |
| CapRetrieveMarker |
Gets the Boolean value that indicates whether the application can use the Microsoft.PointOfService.ElectronicJournal.RetrieveMarker(PointOfService.MarkerType, System.Int32, System.Int32) method. |
| CapRetrieveMarkerByDateTime |
Gets the Boolean value that indicates whether the application can use the Microsoft.PointOfService.ElectronicJournal.RetrieveMarkerByDateTime(PointOfService.MarkerType, System.String, System.String) method. |
| CapRetrieveMarkersDateTime |
Gets the Boolean value that indicates whether the application can use the RetrieveMarkersDateTime(String) method. |
| CapStation | |
| CapStatisticsReporting |
Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (Inherited from PosCommon) |
| CapStorageEnabled | |
| CapSuspendPrintContent | |
| CapSuspendQueryContent | |
| 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) |
| CapWatermark |
Gets the Boolean value that indicates whether the device can print predefined background when reprinting journal documents. |
| 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 | (Inherited from PosDevice) |
| DataCount |
Gets the Boolean value that indicates the number of currently queued DataEvent events. |
| DataEventEnabled |
Gets or sets the Boolean value that indicates whether a DataEvent event is delivered whenever 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) |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName |
Gets a short string identifying the device and any pertinent information about it. (Inherited from PosCommon) |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| FlagWhenIdle |
Gets or sets the Boolean value that indicates whether the device delivers a StatusUpdateEvent when it becomes idle. |
| FreezeEvents |
Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (Inherited from PosCommon) |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice | |
| MediumFreeSpace |
Gets the remaining free space of the storage medium, in bytes,. |
| MediumId | |
| MediumIsAvailable |
Gets the Boolean value that indicates whether a recording medium is attached or not. |
| MediumSize |
Gets the size of the storage medium in bytes. |
| OutputId | |
| 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) |
| 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) |
| State |
Gets the current state of the device. (Inherited from PosCommon) |
| Station |
Gets or sets the station for later data storing into the medium. |
| StorageEnabled |
Gets or sets the Boolean value that indicates whether the device is in a recordable state. |
| Suspended |
Gets the Boolean value that indicates whether the printing or data obtaining process is suspended. |
| SynchronizingObject |
Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (Inherited from PosCommon) |
| Watermark | |
Methods
| AddMarker(String) |
Adds a marker to the end of the data that is stored on the recording medium. |
| CancelPrintContent() |
Cancels the suspended data printing process. |
| CancelQueryContent() |
Cancels a suspended data transfer process. |
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) |
Requests exclusive access to the device. (Inherited from PosCommon) |
| ClearInput() |
Clears all buffered device input. |
| ClearOutput() |
Clears all buffered tone outputs. |
| Close() |
Releases the device and its resources. (Inherited from PosCommon) |
| CompareFirmwareVersion(String) |
Determines whether the version of the specified firmware is newer than, older than, or the same as the version of firmware in the physical device. (Inherited from PosCommon) |
| DeleteConfigurationProperty(String) |
Deletes the specified property from the XML configuration file. (Inherited from PosCommon) |
| DirectIO(Int32, Int32, Object) |
Used to communicate directly with the Service Object. (Inherited from PosCommon) |
| EraseMedium() |
Erases all data in the medium. |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| InitializeMedium(String) |
Initializes the recording medium. |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() |
Opens a device for later input/output processing. (Inherited from PosCommon) |
| PrintContent(String, String) |
Prints the current journal document stored in the recording medium onto the connected printer system. |
| PrintContentFile(String) |
Prints the journal document from the specified file onto the connected printer. |
| QueryContent(String, String, String) |
Queries the content and stores it. The format of the data that is stored on the medium depends on the physical device model. |
| Release() |
Releases exclusive access to the device. (Inherited from PosCommon) |
| ResetStatistic(String) |
Resets the specified statistic to 0 (zero). (Inherited from PosCommon) |
| ResetStatistics() |
Resets all statistics associated with a device to 0 (zero). (Inherited from PosCommon) |
| ResetStatistics(StatisticCategories) |
Resets all statistics for a specified category to 0 (zero). (Inherited from PosCommon) |
| ResetStatistics(String[]) |
Resets the specified statistics to 0 (zero). (Inherited from PosCommon) |
| ResumePrintContent() |
Resumes the suspended data printing process. |
| ResumeQueryContent() |
Resumes the suspended data transfer process. |
| RetrieveCurrentMarker(MarkerType) |
Returns the last implicitly stored marker. |
| RetrieveMarker(MarkerType, Int32, Int32) |
Returns a marker implicitly stored on the record medium. |
| RetrieveMarkerByDateTime(MarkerType, String, String) |
Returns a marker implicitly stored on the record medium. |
| RetrieveMarkersDateTime(String) |
Returns the date/time of the given marker. |
| RetrieveStatistic(String) |
Retrieves the specified device statistic. (Inherited from PosCommon) |
| RetrieveStatistics() |
Retrieves all device statistics. (Inherited from PosCommon) |
| RetrieveStatistics(StatisticCategories) |
Retrieves the statistics for the specified category. (Inherited from PosCommon) |
| RetrieveStatistics(String[]) |
Retrieves the specified statistics. (Inherited from PosCommon) |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| SuspendPrintContent() |
Suspends all data transfer from the device and then suspends the device state. |
| SuspendQueryContent() |
Suspends all data transfer from the device, and then suspends the device state. |
| UpdateFirmware(String) |
Updates the firmware of a device with the version of the firmware contained or defined in the file specified by the firmwareFileName parameter regardless of whether that firmware’s version is newer than, older than, or the same as the version of the firmware already in the device. (Inherited from PosCommon) |
| UpdateStatistic(String, Object) |
Updates the value of a specified device statistic. (Inherited from PosCommon) |
| UpdateStatistics(Statistic[]) |
Updates a list of statistics with the corresponding specified values. (Inherited from PosCommon) |
| UpdateStatistics(StatisticCategories, Object) |
Updates the specified category of statistics with the specified value. (Inherited from PosCommon) |
Events
| DataEvent |
Notifies the application that the queried Electronic Journal has finished storing its content in a host file. |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent |
Raised by the Service Object to communicate information directly to the application. (Inherited from PosCommon) |
| ErrorEvent |
Notifies the application that an Electronic Journal error has been detected and that a suitable response by the application is necessary to process the error condition. |
| OutputCompleteEvent |
Notifies the application that the queued output request has completed successfully. |
| StatusUpdateEvent |
Raised by the Service Object to alert the application of a device status change. (Inherited from PosCommon) |