Click or drag to resize

ServerChannelSendError Method

Sends an error report message to OBCOM NetServer.

Namespace:  OBCOM.NetClient
Assembly:  OBCOM.NetClient (in OBCOM.NetClient.dll) Version: 40.82.5945.17884 (40.82.5945.17884)
Syntax
public void SendError(
	string name,
	string description
)

Parameters

name
Type: SystemString
The name of the error. If null then "ERROR" is used.
description
Type: SystemString
The description of the error.
Remarks

Every error has an associated name and description, which are used by OBCOM NetServer to generate an event log, and to display a message in the OBCOM NetServer Console.

After this method has been called, the server application enter a hold state, which can later be released using the ReleaseHold method if the error situation is resolved.

For example, the server application may need to communicate with a database server, but may not be able to open a connection due to some temporal situation. In this case, the server application may use the SendError(String, String) method to report the situation, and then enter an active hold state trying to open the connection to the database server. Once this is done, it releases the hold state using the ReleaseHold method.

See Also