edmiSetUnavailable

EdmiError edmiSetUnavailable(SdaiString unavailableMessage);

Sets the actual EDMdatabase unavailable for new connections. The actual EDMdatabase will be unavailable for new connections until the edmiSetAvailable function is performed, hence the unavailable state will remain during closing and opening of the actual EDMdatabase. Clients trying to connect to an unavailable EDMdatabase will receive the message specified in the last edmiSetUnavailable function. This message should normally give the reason why the EDMdatabase is being unavailable. This function is protected, i.e. only legal for the privileged EDM user superuser.

Arguments


TypeNameComment
SdaiStringunavailableMessageSpecifies the message that will be returned to the clients that tries to connect to an unavailable EDMserver (EDMdatabase ). This message should normally give the reason why the actual EDMserver is unavailable.

Return Value


Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_EDMInterface'.

Options


 

Example


 

 EdmiError rstat;
 . . .
 if (rstat = edmiSetUnavailable ("\nServer maintenance! (HKD)\n")) {
 /* Error in operation */ 
 printf("\nError: %s in edmiSetUnavailable\n", 
 edmiGetErrorText(rstat)); 
 goto error; 
 }
 /* EDMserver is unavailable */
 . . .

 

See also

Filter by label

There are no items with the selected labels at this time.