Requests the local HMI to shutdown gracefully, but without initiating a backup request if active.
DWORD hmiShutdown ( CTAHD ctahd)
|
Argument |
Description |
|
ctahd |
Natural Access handle from a previous successful call to ctaOpenServices. |
|
Return value |
Description |
|
SUCCESS |
|
|
HMI_ERR_BADCMD |
Request failed. An event handle was passed to the Health Management service command. |
|
HMI_ERR_CLOSED |
Request failed. Connection closed by HMI. |
|
HMI_ERR_INTERROR |
Request failed. Unknown I/O error occurred. |
|
HMI_ERR_INVHANDLE |
Handle is not valid. |
|
HMI_ERR_NOMEM |
No memory available. |
|
HMI_ERR_TIMEOUT |
Request failed. No response from HMI. |
hmiShutdown causes the HMI service to shutdown immediately. If the board that is shut down is the primary board, no HMI service backup request is performed, since shutting down does not change the status of the board. If the user wants to immediately switchover before the primary board shuts down, the HMI service backup request must be issued before the shutdown request and an HMI primary request must be issued for the other board.
All applications registered for unsolicited status events are notified of the pending shutdown with a HMI_EVN_SERVICE_DOWN event.