TCPServiceIsInError

function

Library: TCP/IP client and server support (OMTCP legacy, OmniMark versions 4 - 6.0.1)
Include: omtcp.xin

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

Declaration

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

Purpose

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