Fonction ComDBClaimPort (msports.h)

Article
02/29/2024

ComDBClaimPort consigne un numéro de port COM inutilisé comme « en cours d’utilisation » dans la base de données de ports COM.

Syntaxe

LONG ComDBClaimPort(
  [in]            HCOMDB HComDB,
  [in]            DWORD  ComNumber,
  [in]            BOOL   ForceClaim,
  [out, optional] PBOOL  Forced
);

Paramètres

[in] HComDB

Gérez la base de données de port COM retournée par ComDBOpen.

[in] ComNumber

Spécifie le numéro de port COM que l’appelant tente de revendiquer. Un numéro de port est un entier qui peut varier de 1 à COMDB_MAX_PORTS_ARBITRATED.

[in] ForceClaim

Réservé à un usage interne uniquement.

[out, optional] Forced

Réservé à un usage interne uniquement.

Valeur retournée

ComDBClaimPort retourne l’une des valeurs status suivantes.

Code de retour	Description
ERROR_SUCCESS	Le numéro de port COM n’était pas utilisé et est maintenant enregistré comme « en cours d’utilisation ».
ERROR_CANTWRITE	La routine n’a pas pu écrire dans la base de données.
ERROR_INVALID_PARAMETER	L’une des conditions suivantes est vraie : le handle spécifié pour la base de données de port COM n’est pas valide. Le numéro de port spécifié est supérieur à COMDB_MAX_PORTS_ARBITRATED.
ERROR_NOT_CONNECTED	La routine n’a pas pu accéder à la base de données. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.
ERROR_SHARING_VIOLATION	Le numéro de port spécifié est déjà utilisé.
ERROR_Xxx	Une erreur interne s’est produite ; appelez GetLastError pour obtenir des informations d’erreur étendues.

Remarques

La revendication d’un numéro de port COM dans la base de données de port COM journalise le numéro de port comme « en cours d’utilisation ». Notez que la base de données ne contient pas d’informations sur l’appelant ou l’appareil qui revendique un numéro de port.

ComDBClaimPort s’exécute en mode utilisateur.

Pour plus d’informations, consultez Obtention et libération d’un numéro de port COM.