Função ComDBClaimPort (msports.h)

2024-02-29

ComDBClaimPort registra um número de porta COM não utilizado como "em uso" no banco de dados de porta COM.

Sintaxe

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

Parâmetros

[in] HComDB

Manipule para o banco de dados de porta COM retornado pelo ComDBOpen.

[in] ComNumber

Especifica qual número de porta COM o chamador tenta reivindicar. Um número de porta é um inteiro que pode variar de 1 a COMDB_MAX_PORTS_ARBITRATED.

[in] ForceClaim

Reservado apenas para uso interno.

[out, optional] Forced

Reservado apenas para uso interno.

Retornar valor

ComDBClaimPort retorna um dos seguintes valores de status.

Código de retorno	Descrição
ERROR_SUCCESS	O número da porta COM não estava em uso e agora está registrado como "em uso".
ERROR_CANTWRITE	A rotina não pôde gravar no banco de dados.
ERROR_INVALID_PARAMETER	Uma das opções a seguir é verdadeira: o identificador especificado para o banco de dados de porta COM não é válido. O número de porta especificado é maior que COMDB_MAX_PORTS_ARBITRATED.
ERROR_NOT_CONNECTED	A rotina não pôde acessar o banco de dados. Para obter informações de erro estendidas, chame GetLastError.
ERROR_SHARING_VIOLATION	O número da porta especificado já está em uso.
ERROR_Xxx	Ocorreu um erro interno; chame GetLastError para obter informações de erro estendidas.

Comentários

A declaração de um número de porta COM no banco de dados de porta COM registra o número da porta como "em uso". Observe que o banco de dados não contém informações sobre o chamador ou dispositivo que declara um número de porta.

ComDBClaimPort é executado no modo de usuário.

Para obter mais informações, consulte Obtendo e liberando um número de porta COM.