When trying to connect from a thick EDMclient to a remote EDMserver, one may experience that the connection is refused due to ongoing mainteneance on the server. An EDMserver may be set unavailable by the system administrator with a call to the function edmiRemoteSetUnavailable. The unavailable-message is given as an input argument to this call.
If a remote EDMInterface call returns the sdaiErrorCode edmiEUNAVAILABLE, this function may be used to read the explaining message that was given by the system administrator.
Header:
#include "sdai.h"
Prototype:
EdmiError edmiRemoteGetUnavailableMessage(SdaiServerContext serverContextId,
SdaiString *unavailableMessage,
SdaiInvocationId *edmiInvocationId);
Arguments:
serverContextId |
Context identification, from edmiDefineServerContext |
unavailableMessage |
If the system administrator has set the remote _EDMserver_ unavailable with a call to the function edmiRemoteSetUnavailable, this variable will receive the message given to explain why. |
edmiInvocationId |
Currently not used. |
Returns:
A completion code of datatype EdmiError is the returned function value. The completion code has the following values:
Completion code = 0 : Operation successfully performed.
Completion code != 0: Error in operation. Completion code is an _EDMinterface_ error code. Use edmiGetErrorText to get the error text corresponding to the error code.
Example:
. . .