ElectronicJournal Members
2/27/2008
Defines the programmatic interface for an Electronic Journal device.
The following tables list the members exposed by the ElectronicJournal type.
Protected Constructors
| Name | Description | |
|---|---|---|
| ElectronicJournal | Creates an instance of the ElectronicJournal class. |
Top
Public Fields
| Name | Description | |
|---|---|---|
.gif "Bb428987.pubfield(en-us,WinEmbedded.1002).gif") .gif "Bb428987.static(en-us,WinEmbedded.1002).gif") |
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) |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "Bb428987.pubproperty(en-us,WinEmbedded.1002).gif") |
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 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 RetrieveCurrentMarker method. |
|
CapRetrieveMarker | Gets the Boolean value that indicates whether the application can use the RetrieveMarker method. |
|
CapRetrieveMarkerByDateTime | Gets the Boolean value that indicates whether the application can use the RetrieveMarkerByDateTime method. |
|
CapRetrieveMarkersDateTime | Gets the Boolean value that indicates whether the application can use the RetrieveMarkersDateTime method. |
|
CapStation | Gets the availability of data capturing for the device and the storage medium. |
|
CapStatisticsReporting | Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (inherited from PosCommon) |
|
CapStorageEnabled | Gets the Boolean value that indicates whether the recording of print data can be managed by the StorageEnabled property. |
|
CapSuspendPrintContent | Gets the Boolean value that indicates whether the printing process can be suspended. |
|
CapSuspendQueryContent | Gets the Boolean value that indicates whether the data querying process can be suspended. |
|
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 | Gets the compatibility level of a device. (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) |
|
DeviceName | Gets a short string identifying the device and any pertinent information about it. (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) |
|
MediumFreeSpace | Gets the remaining free space of the storage medium, in bytes,. |
|
MediumId | Gets identification for the currently plugged medium. |
|
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 | Gets the identifier of the most recently started asynchronous output. |
|
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 | Gets or sets the Boolean value that indicates whether a predefined background should be printed with journal documents. |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "Bb428987.protproperty(en-us,WinEmbedded.1002).gif") |
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 device is an exclusive-use device. |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "Bb428987.pubmethod(en-us,WinEmbedded.1002).gif") |
AddMarker | 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 | (inherited from PosCommon ) |
|
Claim | (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 | (inherited from PosCommon ) |
|
DirectIO | (inherited from PosCommon ) |
|
Equals | Overloaded. (inherited from Object ) |
|
EraseMedium | Erases all data in the medium. |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
InitializeMedium | Initializes the recording medium. |
|
Open | Opens a device for later input/output processing. (inherited from PosCommon) |
|
PrintContent | Prints the current journal document stored in the recording medium onto the connected printer system. |
|
PrintContentFile | Prints the journal document from the specified file onto the connected printer. |
|
QueryContent | Queries the content and stores it. The format of the data that is stored on the medium depends on the physical device model. |
| |
ReferenceEquals | (inherited from Object ) |
|
Release | Releases exclusive access to the device. (inherited from PosCommon) |
|
ResetStatistic | (inherited from PosCommon ) |
|
ResetStatistics | Overloaded. (inherited from PosCommon ) |
|
ResumePrintContent | Resumes the suspended data printing process. |
|
ResumeQueryContent | Resumes the suspended data transfer process. |
|
RetrieveCurrentMarker | Returns the last implicitly stored marker. |
|
RetrieveMarker | Returns a marker implicitly stored on the record medium. |
|
RetrieveMarkerByDateTime | Returns a marker implicitly stored on the record medium. |
|
RetrieveMarkersDateTime | Returns the date/time of the given marker. |
|
RetrieveStatistic | (inherited from PosCommon ) |
|
RetrieveStatistics | Overloaded. (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. |
|
ToString | (inherited from Object ) |
|
UpdateFirmware | (inherited from PosCommon ) |
|
UpdateStatistic | (inherited from PosCommon ) |
|
UpdateStatistics | Overloaded. (inherited from PosCommon ) |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "Bb428987.protmethod(en-us,WinEmbedded.1002).gif") |
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 | |
|---|---|---|
.gif "Bb428987.pubevent(en-us,WinEmbedded.1002).gif") |
DataEvent | Notifies the application that the queried Electronic Journal has finished storing its content in a host file. |
|
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) |
Top
Protected Events
| Name | Description | |
|---|---|---|
.gif "Bb428987.protevent(en-us,WinEmbedded.1002).gif") |
DeviceAddedEvent | (inherited from PosCommon ) |
|
DeviceRemovedEvent | (inherited from PosCommon ) |
Top