Partager via

Classe PosCommon (documentation du SDK POS pour .NET v1.14)

PosCommon est la classe de Base pour toutes les classes d’Interface spécifiques, et tous les objets de service en dérivent indirectement. PosCommon définit les propriétés, méthodes et événements courants requis par la spécification Unified Point Of Service (UnifiedPOS) dans toutes les classes d’appareil.

Propriétés PosCommon

Le tableau suivant décrit les propriétés de la classe PosCommon disponible pour les applications POS.

Propriété Type Description
CapCompareFirmwareVersion bool Indique si l’objet de service et l’appareil prennent en charge la comparaison de la version du microprogramme dans l’appareil physique à celle d’un fichier de microprogramme.
CapPowerReporting Énumération PowerReporting Indique les fonctionnalités de création de rapports d’alimentation de l’appareil.
CapStatisticsReporting bool Indique si l’appareil peut accumuler et fournir diverses statistiques d’utilisation.
CapUpdateStatistics bool Si la valeur est true, une partie ou la totalité des statistiques d’appareil peuvent être réinitialisées à 0 (zéro) à l’aide de la méthode ResetStatistic pour une mise à jour, et de la méthode ResetStatistics pour une liste de mises à jour, ou mises à jour à l’aide de la méthode UpdateStatistics pour une mise à jour, et de la méthode UpdateStatistics pour une liste de mises à jour avec les valeurs spécifiées correspondantes.
CapUpdateFirmware bool Indique si le microprogramme de l’appareil peut être mis à jour via la méthode UpdateFirmware.
CheckHealthText string Indique l’intégrité de l’appareil.
Claimed bool Indique si l’appareil est revendiqué pour l’accès exclusif.
DeviceDescription string Contient une chaîne identifiant l’appareil et l’entreprise qui l’a fabriqué.
DeviceEnabled bool Indique si l’appareil est dans un état opérationnel.
DeviceName string UnifiedPOS l’appelle PhysicalDeviceName ; OLE pour Retail POS (OPOS) l’appelle DeviceName.
DevicePath string Défini par POS pour .NET pour les appareils Plug-and-Play. Pour les appareils non Plug-and-Play, DevicePath peut être affecté à l’aide d’un fichier de configuration.
FreezeEvents bool Lorsque la valeur est définie sur true, l’application a demandé à l’objet de service de ne pas remettre d’événements.
PowerNotify Énumération PowerNotification Contient le type de sélection de notification d’alimentation effectuée par l’application.
PowerState Énumération PowerState Conserve l’état d’alimentation actuel.
ServiceObjectDescription string Identifie l’objet de service qui prend en charge l’appareil et l’entreprise qui l’a produit. Cette propriété est répertoriée comme DeviceServiceDescription dans la spécification UnifiedPOS.
ServiceObjectVersion System.Version Contient le numéro de version de l’objet de service. Cette propriété est répertoriée comme DeviceServiceVersion dans la spécification UnifiedPOS.
State Énumération ControlState Contient l’état actuel de l’appareil.
SynchronizingObject ISynchronizeInvoke Obtient ou définit l’objet de marshaling pour les appels de gestionnaire d’événements à partir d’un événement POS.

Méthodes PosCommon

Le tableau suivant décrit les méthodes de la classe PosCommon disponibles pour les applications.

Méthode Type renvoyé Description
CheckHealth string Effectue un contrôle d’intégrité sur l’appareil. Le type de vérification à effectuer est indiqué par le paramètre HealthCheckLevel. La méthode met également à jour la propriété CheckHealthText.
Revendication void Demande un accès exclusif à l’appareil. Il est recommandé aux enregistreurs d’objets de service de lever uniquement des exceptions dans des conditions inattendues ; par exemple, OutOfMemory. Dans le cas contraire, les objets de service doivent retourner True si l’appareil a été revendiqué et False si un délai d’expiration s’est produit.
Fermer void Libère l’appareil et ses ressources.
CompareFirmwareVersion CompareFirmwareResult Détermine si la version du microprogramme spécifié est plus récente, antérieure à ou identique à la version du microprogramme dans l’appareil physique.
DirectIO DirectIOData Utilisé pour communiquer directement avec l’objet de service. Dans la spécification UnifiedPOS, il a deux paramètres d’entrée/sortie. Telle qu’utilisée par POS pour .NET, cette méthode retourne une structure et n’a aucun paramètre d’entrée/sortie.
Ouvrir void Ouvre un appareil pour le traitement d’entrée/sortie suivant.
Libérer void Libère l’accès exclusif à l’appareil.
ResetStatistic void Rétablit la statistique spécifiée à zéro. Utilisé dans POS pour .NET pour les opérations sur une statistique unique.
ResetStatistics void Réinitialise toutes les statistiques d’une catégorie spécifiée à 0 (zéro).
ResetStatistics void Réinitialise les statistiques spécifiées à 0 (zéro).
ResetStatistics void Réinitialise toutes les statistiques associées à un appareil à 0 (zéro).
RetrieveStatistic string Récupère la statistique d’appareil spécifiée. Utilisé dans POS pour .NET pour les opérations sur une statistique unique.
RetrieveStatistics string Récupère toutes les statistiques d’appareil.
RetrieveStatistics void Récupère les statistiques pour la catégorie spécifiée.
RetrieveStatistics void Récupère les statistiques spécifiées.
UpdateFirmware void Mises à jour le microprogramme d’un appareil avec la version du microprogramme contenue dans le nom de fichier spécifié.
UpdateStatistic void Met à jour une statistique. Ajouté à POS pour .NET pour les opérations sur une statistique unique.
UpdateStatistics void Met à jour une liste de statistiques avec les valeurs spécifiées correspondantes.
UpdateStatistics void Met à jour la catégorie de statistiques spécifiée avec la valeur spécifiée.

Événements PosCommon

Le tableau suivant décrit les événements de la classe PosCommon.

Méthode Description
DirectIOEvent Déclenché par l’objet de service pour communiquer des informations directement à l’application.
StatusUpdateEvent Déclenché par l’objet de service pour alerter l’application d’un changement d’état de l’appareil.

Exemple

L’exemple de code suivant montre comment utiliser les propriétés et méthodes communes à tous les objets de service pour afficher des informations sur un appareil connecté.

// 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();

Voir aussi

Concepts

  • Last updated on