Error

UCM Error

Error(E)

Name Environment Synopsis Description Parameters Notes See also

Name

Error

Environment

Windows

Synopsis

Sub Ucm_Error(ErrNumber As ucmErrors, ErrText As String)

Description

The Error event is raised when the communication manager Ucm.exe(U) detects an error. All flagged errors should cause the underlying application program to terminate without further communication requests.

Error Code Term Text

ucmErrInternal 1 X Internal error (specific text).

ucmErrNoMem 2 X Out of memory.

ucmErrCanceled 3 The operation was canceled.

ucmErrBlocking 4 X The socket operation will block.

ucmErrAddress 5 X General addressing error.

ucmErrBusy 6 A socket operation in progress.

ucmErrSize 7 The message is too large to fit into the buffer and is discarded.

ucmErrPort 8 The specified port is not supported.

ucmErrInUse 9 Address in use.

ucmErrUnavailable 10 Address not available from the local machine.

ucmErrNet 11 X Network subsystem failed.

ucmErrNetDown 12 X The network cannot be reached from this host at this time.

ucmErrNetReset 13 X Connection has has been reset.

ucmErrTimeout 14 X Connection is aborted due to timeout or other failure.

ucmErrConnReset 15 X The connection is reset by remote side.

ucmErrNoBuf 16 X No buffer space is available.

ucmConnExists 17 X Socket is already connected (should not occur).

ucmNotConn 18 X Socket is not connected (should not occur).

ucmErrSockDown 19 X Socket has been shut down.

ucmErrReject 20 X Connection is forcefully rejected.

ucmErrNotInit 21 X The Windows socket layer is not initialized (should not occur).

ucmErrHost 22 Host not found.

ucmErrNoData 23 No data record.

ucmErrUnknown 99 X Unknown error.

ucmErrServiceUnknown 101 Service (TCP/IP port) unknown.

ucmErrMngrShutdown 102 X UCM manager shutting down.

Parameters

ErrNumber (ucmError enumeration), ErrText (String)

Notes

When multiple controls are attached to the same communication link, most of the errors will be sent to each of them. The suggested handling is to define a global error flag which is set upon the first fatal Error event. When the global error flag is set, subsequent events should then be ignored and termination routines should avoid to send further messages through the control.