Library: TCP/IP client and server support (OMTCP) original Include: omtcp.xin

Return type: Boolean Returns:  True if the TCP service is in error; false otherwise.

Declaration

  define external switch function TCPServiceIsInError
        value TCPService this-TCPService
  as TCPServiceIsInError

This function simply detects whether the TCP service is in error. This usually occurs when a TCPServiceOpen fails.

Errors in initiating a TCP service are recorded in the TCP service itself, or in the TCP connection object derived from it.

Argument:

• "this-TCPService" is an OMX component of type TCPService.

Example

  do when TCPServiceIsInError omdemo-service
     local stream errorReport variable

    TCPServiceGetStatusReport omdemo-service into errorReport
    output "TCPService Error:%n"
    repeat over errorReport
      output errorReport || "%n"
    again
  done

Other Library Functions    TCPConnection    TCPConnectionClose    TCPConnectionGetCharacters    TCPConnectionGetLine    TCPConnectionGetOutput    TCPConnectionGetPeerIP    TCPConnectionGetPeerName    TCPConnectionGetSource    TCPConnectionGetStatusReport    TCPConnectionHasCharactersToRead    TCPConnectionIsConnected    TCPConnectionIsInError    TCPConnectionOpen    TCPConnectionPut    TCPConnectionSetBuffering    TCPConnectionSignalSourceEnd    TCPIsVersionCompatible    TCPLibraryVersion    TCPService    TCPServiceAcceptConnection    TCPServiceClose    TCPServiceGetPort    TCPServiceGetStatusReport    TCPServiceIsInError    TCPServiceIsOpen    TCPServiceOpen    TCPTraceConnectionOpen

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]