[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
  GetCommError( nIdComDev, @cComStat )-> <nRetCode>
------------------------------------------------------------------------------


 PARAMETER:

  <nIdComDev>  Is the communications device identifier created with the
               OpenComm() function.

  <cComStat>   Is a string, supplied by reference, that will receive the
               COMSTAT information structure.


 RETURNS:

  <nRetCode> is the last error value. It can be a combination of the
  following values: 

      CE_BREAK     Hardware detected a break condition. 
      CE_CTSTO     CTS (clear-to-send) timeout. While a character was being
                   transmitted, CTS was low for the duration specified by
                   the fCtsHold member of <comStat>
      CE_DNS       Parallel device was not selected. 
      CE_DSRTO     DSR (data-set-ready) timeout. While a character was being
                   transmitted, DSR was low for the duration specified by
                   the fDsrHold member of <comStat>
      CE_FRAME     Hardware detected a framing error
      CE_IOE       I/O error occurred during an attempt to communicate with
                   a parallel device. 
      CE_MODE      Requested mode is not supported, or <idComDev> is  
                   invalid. If set, CE_MODE is the only valid error. 
      CE_OOP       Parallel device signaled that it is out of paper
      CE_OVERRUN   Character was not read from the hardware before the next
                   character arrived. The character was lost. 
      CE_PTO       Timeout occurred during an attempt to communicate with a
                   parallel device. 
      CE_RLSDTO    RLSD (receive-line-signal-detect) timeout. While a
                   character was being transmitted, RLSD was low for the
                   duration specified by the fRlsdHold member of <comStat>
      CE_RXOVER    Receiving queue overflowed. There was either no room in
                   the input queue or a character was received after the 
                   end-of-file character was received. 
      CE_RXPARITY  Hardware detected a parity error. 
      CE_TXFULL    Transmission queue was full when a function attempted to
                   queue a character. 


 DESCRIPTION:

  The GetCommError function retrieves the most recent error value and
  current status for the specified device. 
  When a communications error occurs, Windows locks the communications port
  until GetCommError clears the error. See SAMPLES\TestComm.prg for an
  example.

 SOURCE:

  SOURCE\WINAPI\COMM.C



See Also: OpenComm BuildCommDCB CloseComm
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson