Reads the optional message given by the system administrator when the EDMserver has been set unavailable for maintenance reasons.
Header:
#include "sdai.h"
Prototype:
EdmiError edmiGetUnavailableMessage(SdaiString *unavailableMessage);
Arguments:
*unavailableMessage |
Variable that will receive a pointer to a message from the system administrator. The text string will be located in an internal buffer and will be overwritten by the next EDMinterface call. Do not free this address with edmiFree; |
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
SdaiInteger nConnected;
tEdmiWhoIsOn *pWhoIsOn;
SdaiString unavailMsg;
. . .
if (edmiWhoIsOn(&nConnected, &pWhoIsOn) == edmiEUNAVAILABLE)) {
edmiGetUnavailableMessage(&unavailMsg);
printf("NOTE: System is unavailable!\n")
printf("Message from System Administrator\n");
printf("%s", unavailMsg);
}