Поделиться через

Функция ComDBClaimPort (msports.h)

  • Статья

ComDBClaimPort регистрирует неиспользуемый номер COM-порта как "используемый" в базе данных COM-портов.

Синтаксис

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

Параметры

[in] HComDB

Дескриптор в базу данных com-портов, возвращаемую comDBOpen.

[in] ComNumber

Указывает номер COM-порта, который пытается запросить вызывающий объект. Номер порта — это целое число, которое может варьироваться от 1 до COMDB_MAX_PORTS_ARBITRATED.

[in] ForceClaim

Зарезервировано только для внутреннего использования.

[out, optional] Forced

Зарезервировано только для внутреннего использования.

Возвращаемое значение

ComDBClaimPort возвращает одно из следующих значений состояния.

Код возврата Описание
ERROR_SUCCESS
 Номер порта COM не использовался и теперь регистрируется как "используется".
ERROR_CANTWRITE
 Подпрограмме не удалось выполнить запись в базу данных.
ERROR_INVALID_PARAMETER
 Верно одно из следующих значений: указанный дескриптор для базы данных COM-портов недопустим. Указанный номер порта больше COMDB_MAX_PORTS_ARBITRATED.
ERROR_NOT_CONNECTED
 Подпрограмме не удалось получить доступ к базе данных. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.
ERROR_SHARING_VIOLATION
 Указанный номер порта уже используется.
ERROR_Xxx
 Произошла внутренняя ошибка; вызовите Метод GetLastError , чтобы получить расширенные сведения об ошибке.

Комментарии

При запросе номера COM-порта в базе данных COM-портов номер порта регистрируется как "используемый". Обратите внимание, что база данных не содержит сведений о вызывающем объекте или устройстве, которое утверждает номер порта.

ComDBClaimPort работает в пользовательском режиме.

Дополнительные сведения см. в разделе Получение и освобождение номера порта COM.

Требования

Требование Значение
Целевая платформа Персональный компьютер
Верхняя часть msports.h (включая Msports.h)
Библиотека Msports.lib
DLL Msports.dll

См. также раздел

ComDBClaimNextFreePort

ComDBReleasePort