ElectronicJournalBasic 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.
public abstract class ElectronicJournalBasic : Microsoft.PointOfService.ElectronicJournal, IDisposabletype ElectronicJournalBasic = class
inherit ElectronicJournal
interface IDisposablePublic MustInherit Class ElectronicJournalBasic
Inherits ElectronicJournal
Implements IDisposable- Inheritance
- Implements
Constructors
| ElectronicJournalBasic() |
Fields
| ExtendedErrorCorruptedMedium |
Indicates that the medium is corrupted. (Inherited from ElectronicJournal) |
| ExtendedErrorExisting |
Indicates that the marker name is already specified in the medium. (Inherited from ElectronicJournal) |
| 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. (Inherited from ElectronicJournal) |
| ExtendedErrorMultipleMarker |
Indicates that more than one marker exists for the specified time period. (Inherited from ElectronicJournal) |
| ExtendedErrorMultipleMarkers |
Indicates that, although multiple markers were requested, only one can be returned. (Inherited from ElectronicJournal) |
| ExtendedErrorNotEnoughSpace |
Indicates that there is insufficient free space. (Inherited from ElectronicJournal) |
| 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. (Inherited from ElectronicJournal) |
| ExtendedErrorUnknownDataFormat |
Indicates that the medium has an unknown or unsupported data format. (Inherited from ElectronicJournal) |
| 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. (Inherited from ElectronicJournal) |
| StatisticFailedWriteCount |
Holds the number of failed write operations. (Inherited from ElectronicJournal) |
| 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. (Inherited from ElectronicJournal) |
| StatisticMediumRemovedCount |
Indicates the number of times the medium is removed. (Inherited from ElectronicJournal) |
| StatisticMediumSize |
Indicates the medium size. (Inherited from ElectronicJournal) |
| 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. (Inherited from ElectronicJournal) |
| StatusIdle | (Inherited from ElectronicJournal) |
| StatusMediumFull |
Holds a value that indicates that the medium is full. (Inherited from ElectronicJournal) |
| StatusMediumInserted |
Holds a value that indicates that the medium is currently inserted. (Inherited from ElectronicJournal) |
| StatusMediumNearFull |
Holds a value that indicates that the medium is almost full. (Inherited from ElectronicJournal) |
| StatusMediumRemoved |
Holds a value that indicates that the medium has been removed. (Inherited from ElectronicJournal) |
| StatusMediumSuspended |
Holds a value that indicates that the medium is suspended. (Inherited from ElectronicJournal) |
| 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. (Inherited from ElectronicJournal) |
| AutoDisable | |
| CapAddMarker |
Gets the Boolean value that indicates whether the application can use the AddMarker(String) method. (Inherited from ElectronicJournal) |
| CapCompareFirmwareVersion | |
| CapErasableMedium |
Gets the Boolean value that indicates whether the storage medium can be erased. (Inherited from ElectronicJournal) |
| CapInitializeMedium |
Gets the Boolean value that indicates whether the application can initialize the medium. (Inherited from ElectronicJournal) |
| CapMediumIsAvailable |
Gets the Boolean value that indicates whether the application can search for a connected recording medium. (Inherited from ElectronicJournal) |
| CapPowerReporting | |
| CapPrintContent |
Gets the Boolean value that indicates whether the device can reprint stored journal documents on a connected printer. (Inherited from ElectronicJournal) |
| 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. (Inherited from ElectronicJournal) |
| CapRetrieveCurrentMarker |
Gets the Boolean value that indicates whether the application can use the Microsoft.PointOfService.ElectronicJournal.RetrieveCurrentMarker(PointOfService.MarkerType) method. (Inherited from ElectronicJournal) |
| CapRetrieveMarker |
Gets the Boolean value that indicates whether the application can use the Microsoft.PointOfService.ElectronicJournal.RetrieveMarker(PointOfService.MarkerType, System.Int32, System.Int32) method. (Inherited from ElectronicJournal) |
| CapRetrieveMarkerByDateTime |
Gets the Boolean value that indicates whether the application can use the Microsoft.PointOfService.ElectronicJournal.RetrieveMarkerByDateTime(PointOfService.MarkerType, System.String, System.String) method. (Inherited from ElectronicJournal) |
| CapRetrieveMarkersDateTime |
Gets the Boolean value that indicates whether the application can use the RetrieveMarkersDateTime(String) method. (Inherited from ElectronicJournal) |
| CapStation | (Inherited from ElectronicJournal) |
| CapStatisticsReporting | |
| CapStorageEnabled | (Inherited from ElectronicJournal) |
| CapSuspendPrintContent | (Inherited from ElectronicJournal) |
| CapSuspendQueryContent | (Inherited from ElectronicJournal) |
| CapUpdateFirmware | |
| CapUpdateStatistics | |
| CapWatermark |
Gets the Boolean value that indicates whether the device can print predefined background when reprinting journal documents. (Inherited from ElectronicJournal) |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed | |
| CommonProperties | |
| Compatibility | (Inherited from PosDevice) |
| DataCount | |
| DataEventEnabled | |
| DeviceDescription | |
| DeviceEnabled | |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName | |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| ErrorCount | |
| ExternallyClaimed | |
| FlagWhenIdle |
Gets or sets the Boolean value that indicates whether the device delivers a StatusUpdateEvent when it becomes idle. (Inherited from ElectronicJournal) |
| FreezeEvents | |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice | (Inherited from ElectronicJournal) |
| MediumFreeSpace |
Gets the remaining free space of the storage medium, in bytes,. (Inherited from ElectronicJournal) |
| MediumId | (Inherited from ElectronicJournal) |
| MediumIsAvailable |
Gets the Boolean value that indicates whether a recording medium is attached or not. (Inherited from ElectronicJournal) |
| MediumSize |
Gets the size of the storage medium in bytes. (Inherited from ElectronicJournal) |
| OutputId | |
| PowerNotify | |
| PowerState | |
| ServiceObjectDescription | |
| ServiceObjectVersion | |
| State | |
| Station |
Gets or sets the station for later data storing into the medium. (Inherited from ElectronicJournal) |
| StorageEnabled |
Gets or sets the Boolean value that indicates whether the device is in a recordable state. (Inherited from ElectronicJournal) |
| Suspended |
Gets the Boolean value that indicates whether the printing or data obtaining process is suspended. (Inherited from ElectronicJournal) |
| 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 | (Inherited from ElectronicJournal) |
Methods
| AddMarker(String) |
Adds a marker to the end of the data that is stored on the recording medium. (Inherited from ElectronicJournal) |
| CancelPrintContent() |
Cancels the suspended data printing process. (Inherited from ElectronicJournal) |
| CancelQueryContent() |
Cancels a suspended data transfer process. (Inherited from ElectronicJournal) |
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) | |
| ClearInput() | |
| ClearInputImpl() | |
| ClearOutput() | |
| ClearOutputImpl() | |
| Close() | |
| 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) |
| CreateStatistic(String, Boolean, String) | |
| CreateStatistic(String, Boolean) | |
| 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) |
| Dispose() | |
| Dispose(Boolean) | |
| EraseMedium() |
Erases all data in the medium. (Inherited from ElectronicJournal) |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| GetStatisticValue(String) | |
| IncrementStatistic(String, Int32) | |
| IncrementStatistic(String) | |
| InitializeMedium(String) |
Initializes the recording medium. (Inherited from ElectronicJournal) |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() | |
| PreFireEvent(DataEventArgs) | |
| PreFireEvent(DeviceErrorEventArgs) | |
| PreFireEvent(DirectIOEventArgs) | |
| PreFireEvent(OutputCompleteEventArgs) | |
| PreFireEvent(StatusUpdateEventArgs) | |
| PrintContent(String, String) |
Prints the current journal document stored in the recording medium onto the connected printer system. (Inherited from ElectronicJournal) |
| PrintContentFile(String) |
Prints the journal document from the specified file onto the connected printer. (Inherited from ElectronicJournal) |
| 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. (Inherited from ElectronicJournal) |
| QueueEvent(DataEventArgs) | |
| QueueEvent(DeviceErrorEventArgs) | |
| QueueEvent(DirectIOEventArgs) | |
| QueueEvent(OutputCompleteEventArgs) | |
| QueueEvent(StatusUpdateEventArgs) | |
| QueueEventAndWait(DeviceErrorEventArgs) | |
| QueueEventAndWait(DirectIOEventArgs) | |
| Release() | |
| ResetStatistic(String) | |
| ResetStatistics() | |
| ResetStatistics(StatisticCategories) | |
| ResetStatistics(String[]) | |
| ResumePrintContent() |
Resumes the suspended data printing process. (Inherited from ElectronicJournal) |
| ResumeQueryContent() |
Resumes the suspended data transfer process. (Inherited from ElectronicJournal) |
| RetrieveCurrentMarker(MarkerType) |
Returns the last implicitly stored marker. (Inherited from ElectronicJournal) |
| RetrieveMarker(MarkerType, Int32, Int32) |
Returns a marker implicitly stored on the record medium. (Inherited from ElectronicJournal) |
| RetrieveMarkerByDateTime(MarkerType, String, String) |
Returns a marker implicitly stored on the record medium. (Inherited from ElectronicJournal) |
| RetrieveMarkersDateTime(String) |
Returns the date/time of the given marker. (Inherited from ElectronicJournal) |
| RetrieveStatistic(String) | |
| RetrieveStatistics() | |
| RetrieveStatistics(StatisticCategories) | |
| RetrieveStatistics(String[]) | |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| SetStatisticHandlers(String, GetStatistic, SetStatistic) | |
| SetStatisticValue(String, Object) | |
| SuspendPrintContent() |
Suspends all data transfer from the device and then suspends the device state. (Inherited from ElectronicJournal) |
| SuspendQueryContent() |
Suspends all data transfer from the device, and then suspends the device state. (Inherited from ElectronicJournal) |
| 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) | |
| UpdateStatistics(Statistic[]) | |
| UpdateStatistics(StatisticCategories, Object) | |
| VerifyState(Boolean, Boolean) | |
Events
| DataEvent | |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | |
| ErrorEvent | |
| OutputCompleteEvent | |
| StateChangedEvent | |
| StatusUpdateEvent | |