Funzione SetupComm (winbase.h)

Inizializza i parametri di comunicazione per un dispositivo di comunicazione specificato.

Sintassi

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

Parametri

[in] hFile

Handle per il dispositivo di comunicazione. La funzione CreateFile restituisce questo handle.

[in] dwInQueue

Dimensioni consigliate del buffer di input interno del dispositivo, in byte.

[in] dwOutQueue

Dimensioni consigliate del buffer di output interno del dispositivo, in byte.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per informazioni dettagliate sull'errore, chiamare GetLastError.

Commenti

Dopo che un processo usa la funzione CreateFile per aprire un handle a un dispositivo di comunicazione, ma prima di eseguire qualsiasi I/O con il dispositivo, può chiamare SetupComm per impostare i parametri di comunicazione per il dispositivo. Se non li imposta, il dispositivo usa i parametri predefiniti quando si verifica la prima chiamata a un'altra funzione di comunicazione.

I parametri dwInQueue e dwOutQueue specificano le dimensioni consigliate per i buffer interni usati dal driver per il dispositivo specificato. Ad esempio, i pacchetti di protocolli YMODEM sono leggermente maggiori di 1024 byte. Pertanto, una dimensione del buffer consigliata potrebbe essere di 1200 byte per le comunicazioni YMODEM. Per le comunicazioni basate su Ethernet, una dimensione del buffer consigliata potrebbe essere di 1600 byte, che è leggermente maggiore di un singolo frame Ethernet.

Il driver di dispositivo riceve le dimensioni del buffer consigliate, ma è libero di usare qualsiasi schema di buffering di input e output (I/O), purché fornisca prestazioni ragionevoli e i dati non vengano persi a causa dell'overrun (ad eccezione di circostanze estreme). Ad esempio, la funzione può avere esito positivo anche se il driver non alloca un buffer, purché alcune altre parti del sistema forniscano funzionalità equivalenti.

Requisiti

Requisito Valore
Client minimo supportato Windows XP [app desktop | App UWP]
Server minimo supportato Windows Server 2003 [app desktop | App UWP]
Piattaforma di destinazione Windows
Intestazione winbase.h (include Windows.h)
Libreria Kernel32.lib
DLL Kernel32.dll

Vedere anche

Funzioni di comunicazione

Risorse di comunicazione

CreateFile

SetCommState