Função SetupComm (winbase.h)

Inicializa os parâmetros de comunicação para um dispositivo de comunicações especificado.

Sintaxe

BOOL SetupComm(
  [in] HANDLE hFile,
  [in] DWORD  dwInQueue,
  [in] DWORD  dwOutQueue
);

Parâmetros

[in] hFile

Um identificador para o dispositivo de comunicações. A função CreateFile retorna esse identificador.

[in] dwInQueue

O tamanho recomendado do buffer de entrada interno do dispositivo, em bytes.

[in] dwOutQueue

O tamanho recomendado do buffer de saída interno do dispositivo, em bytes.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Depois que um processo usa a função CreateFile para abrir um identificador para um dispositivo de comunicação, mas antes de fazer qualquer E/S com o dispositivo, ele pode chamar SetupComm para definir os parâmetros de comunicação para o dispositivo. Se ele não os definir, o dispositivo usará os parâmetros padrão quando ocorrer a primeira chamada para outra função de comunicação.

Os parâmetros dwInQueue e dwOutQueue especificam os tamanhos recomendados para os buffers internos usados pelo driver para o dispositivo especificado. Por exemplo, os pacotes de protocolo YMODEM são ligeiramente maiores que 1024 bytes. Portanto, um tamanho de buffer recomendado pode ser de 1200 bytes para comunicações YMODEM. Para comunicações baseadas em Ethernet, um tamanho de buffer recomendado pode ser de 1600 bytes, que é ligeiramente maior que um único quadro Ethernet.

O driver do dispositivo recebe os tamanhos de buffer recomendados, mas é livre para usar qualquer esquema de buffer de entrada e saída (E/S), desde que forneça um desempenho razoável e os dados não sejam perdidos devido à sobrecarga (exceto em circunstâncias extremas). Por exemplo, a função pode ter êxito mesmo que o driver não aloque um buffer, desde que alguma outra parte do sistema forneça funcionalidade equivalente.

Requisitos

Confira também

Funções de comunicação

Recursos de comunicação

CreateFile

Setcommstate