Freigeben über

PosCommon-Klasse (POS für .NET v1.14 SDK-Dokumentation)

PosCommon ist die Basisklasse (Base) für alle spezifischen Schnittstellenklassen (Interface), und alle Dienstobjekte werden indirekt von ihr abgeleitet. PosCommon definiert die allgemeinen Eigenschaften, Methoden und Ereignisse, die die UnifiedPOS-Spezifikation (Unified Point Of Service) in allen Geräteklassen erfordert.

PosCommon-Eigenschaften

In der folgenden Tabelle werden die Eigenschaften der Klasse PosCommon beschrieben, die für POS-Anwendungen verfügbar sind:

Eigenschaft Typ BESCHREIBUNG
CapCompareFirmwareVersion bool Gibt an, ob das Dienstobjekt und das Gerät den Vergleich der Firmwareversion auf dem physischen Gerät mit der Version einer Firmwaredatei unterstützen.
CapPowerReporting PowerReporting-Enumeration Gibt die Energieberichterstattungsfunktionen des Geräts an.
CapStatisticsReporting bool Gibt an, ob das Gerät verschiedene nutzungsbezogene Statistiken akkumulieren und bereitstellen kann.
CapUpdateStatistics bool Ist diese Eigenschaft auf „true“ festgelegt, können einige oder alle Gerätestatistiken mithilfe der Methode „ResetStatistic“ (für ein einzelnes Update) bzw. mithilfe der Methode „ResetStatistics“ (für eine Liste von Updates) auf null zurückgesetzt oder mithilfe der Methode „UpdateStatistic“ (für ein einzelnes Update) bzw. mithilfe der Methode „UpdateStatistics“ (für eine Liste von Updates) mit den entsprechenden angegebenen Werten aktualisiert werden.
CapUpdateFirmware bool Gibt an, ob die Firmware des Geräts über die Methode „UpdateFirmware“ aktualisiert werden kann.
CheckHealthText Zeichenfolge Gibt die Integrität des Geräts an.
Claimed bool Gibt an, ob das Gerät für exklusiven Zugriff beansprucht wurde.
DeviceDescription Zeichenfolge Enthält eine Zeichenfolge, die das Gerät und den Hersteller identifiziert.
DeviceEnabled bool Gibt an, ob das Gerät betriebsbereit ist.
DeviceName Zeichenfolge In UnifiedPOS heißt diese Eigenschaft „PhysicalDeviceName“. In OLE for Retail POS (OPOS) heißt sie „DeviceName“.
DevicePath Zeichenfolge Wird von POS für .NET für Plug & Play-Geräte festgelegt. Für Geräte ohne Plug & Play kann „DevicePath“ mithilfe einer Konfigurationsdatei zugewiesen werden.
FreezeEvents bool Ist diese Eigenschaft auf „true“ festgelegt, wurde von der Anwendung angefordert, dass das Dienstobjekt keine Ereignisse übermittelt.
PowerNotify PowerNotification-Enumeration Enthält die Art der Energiebenachrichtigungsauswahl, die von der Anwendung getroffen wurde.
PowerState PowerState-Enumeration Enthält den aktuellen Energiezustand.
ServiceObjectDescription Zeichenfolge Gibt das Dienstobjekt an, das das Gerät unterstützt, sowie das Unternehmen, das es erstellt hat. Diese Eigenschaft ist in der UnifiedPOS-Spezifikation als „DeviceServiceDescription“ aufgeführt.
ServiceObjectVersion System.Version Enthält die Versionsnummer des Dienstobjekts. Diese Eigenschaft ist in der UnifiedPOS-Spezifikation als „DeviceServiceVersion“ aufgeführt.
State ControlState-Enumeration Enthält den aktuellen Zustand des Geräts.
SynchronizingObject ISynchronizeInvoke Ruft das Marshallingobjekt für Ereignishandleraufrufe aus einem POS-Ereignis ab oder legt es fest.

PosCommon-Methoden

In der folgenden Tabelle werden die Methoden der Klasse PosCommon beschrieben, die für Anwendungen verfügbar sind:

Methode Rückgabetyp BESCHREIBUNG
CheckHealth Zeichenfolge Führt eine Integritätsprüfung auf dem Gerät durch. Die Art der durchzuführenden Überprüfung wird durch den Parameter „HealthCheckLevel“ angegeben. Die Methode aktualisiert auch die Eigenschaft „CheckHealthText“.
Anspruch void Fordert exklusiven Zugriff auf das Gerät an. Dienstobjekterstellern wird empfohlen, Ausnahmen nur bei unerwarteten Bedingungen auszulösen (Beispiel: OutOfMemory). Andernfalls sollten Dienstobjekte „True“ zurückgeben, wenn das Gerät beansprucht wurde, und „False“, wenn ein Timeout aufgetreten ist.
Schließen void Gibt das Gerät und seine Ressourcen frei.
CompareFirmwareVersion CompareFirmwareResult Bestimmt, ob die Version der angegebenen Firmware neuer, älter oder mit der Firmwareversion des physischen Geräts identisch ist.
DirectIO DirectIOData Wird für die direkte Kommunikation mit dem Dienstobjekt verwendet. In der UnifiedPOS-Spezifikation sind zwei In/Out-Parameter verfügbar. Bei der Verwendung durch POS für .NET gibt diese Methode eine Struktur und keine In/Out-Parameter zurück.
Öffnen void Öffnet ein Gerät zur nachfolgenden Eingabe-/Ausgabeverarbeitung.
Release void Gibt den exklusiven Zugriff auf das Gerät frei.
ResetStatistic void Setzt die angegebene Statistik auf null zurück. Wird in POS für .NET für Vorgänge für eine einzelne Statistik verwendet.
ResetStatistics void Setzt alle Statistiken für eine angegebene Kategorie auf null zurück.
ResetStatistics void Setzt die angegebene Statistik auf null zurück.
ResetStatistics void Setzt alle einem Gerät zugeordneten Statistiken auf null zurück.
RetrieveStatistic Zeichenfolge Ruft die angegebene Gerätestatistik ab. Wird in POS für .NET für Vorgänge für eine einzelne Statistik verwendet.
RetrieveStatistics Zeichenfolge Ruft alle Gerätestatistiken ab.
RetrieveStatistics void Ruft die Statistiken für die angegebene Kategorie ab.
RetrieveStatistics void Ruft den angegebenen Statistiken ab.
UpdateFirmware void Aktualisiert die Firmware eines Geräts mit der Version der Firmware aus dem angegebenen Dateinamen.
UpdateStatistic void Aktualisiert eine Statistik. Wurde in POS für .NET für Vorgänge für eine einzelne Statistik hinzugefügt.
UpdateStatistics void Aktualisiert eine Liste von Statistiken mit den entsprechenden angegebenen Werten.
UpdateStatistics void Aktualisiert die angegebene Statistikkategorie mit dem angegebenen Wert.

PosCommon-Ereignisse

In der folgenden Tabelle werden die Ereignisse der Klasse PosCommon beschrieben:

Methode BESCHREIBUNG
DirectIOEvent Wird vom Dienstobjekt ausgelöst, um Informationen direkt an die Anwendung weiterzugeben.
StatusUpdateEvent Wird vom Dienstobjekt ausgelöst, um die Anwendung über eine Änderung des Gerätestatus zu informieren.

Beispiel

Das folgende Codebeispiel zeigt, wie Sie mithilfe von Eigenschaften und Methoden, die bei allen Dienstobjekten zur Verfügung stehen, Informationen zu einem verbundenen Gerät anzeigen:

// Create a derived class of PosCommon
public class PosCommonSample: PosCommon
{
    // Implement all base methods and properties.
    // ...
}

// Create instances for the example.
PosExplorer explorer = new PosExplorer();
PosCommonSample pcs = new PosCommonSample();
DeviceInfo device = explorer.GetDevice("MSR");
pcs = (PosCommonSample)explorer.CreateInstance(device);

// Open and claim the device, then print information
// about the device to the console.
pcs.Open();
pcs.Claim(1000);
Console.WriteLine("Name: {0}", pcs.DeviceName);
Console.WriteLine("Description: {0}", pcs.DeviceDescription);
Console.WriteLine("Path: {0}", pcs.DevicePath);
Console.WriteLine("Enabled: {0}", pcs.DeviceEnabled);

pcs.Close();

Weitere Informationen

Konzepte