ComDBClaimNextFreePort, fonction (msports.h)

Article
02/29/2024

ComDBClaimNextFreePort retourne le numéro de port COM le plus bas qui n’est pas déjà utilisé.

Syntaxe

LONG ComDBClaimNextFreePort(
  [in]  HCOMDB  HComDB,
  [out] LPDWORD ComNumber
);

Paramètres

[in] HComDB

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

[out] ComNumber

Pointeur vers le numéro de port COM que la routine retourne à l’appelant. Ce pointeur doit être non NULL. Un numéro de port est un entier compris entre 1 et COMDB_MAX_PORTS_ARBITRATED.

Valeur retournée

ComDBClaimNextFreePort retourne l’une des valeurs de status suivantes.

Code de retour	Description
ERROR_SUCCESS	La routine a correctement retourné un numéro de port COM.
ERROR_CANTWRITE	La routine n’a pas pu écrire dans la base de données.
ERROR_INVALID_PARAMETER	Le handle de base de données de port COM spécifié n’est pas valide.
ERROR_NO_LOG_SPACE	La base de données ne peut plus arbitrer les numéros de port.
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_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 ports COM enregistre le numéro de port comme étant « en cours d’utilisation ». Notez que la base de données ne contient pas d’informations sur l’appelant ou l’appareil qui réclame un numéro de port.

ComDBClaimNextFreePort s’exécute en mode utilisateur.

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