(Page 7 of 11 in this chapter) Version

hmiShutdown

Description

Requests the local HMI service to shutdown gracefully, but without initiating a "go backup" message if active.

Prototype

DWORD hmiShutdown (CTAHD ctahd)
ctahd CT Access handle from a previous successful call to ctaOpenServices.

Return Values

SUCCESS
HMI_ERR_CLOSEDRequest failed - connection closed by HMI.
HMI_ERR_BADCMDRequest failed - an event handle was passed to the HM API command.
HMI_ERR_TIMEOUTRequest failed - no response from HMI service.
HMI_ERR_INVHANDLEThe handle is not valid.
HMI_ERR_NOMEMNo memory available.
HMI_ERR_INTERRORRequest failed - unknown I/O error occurred.

Details

This request causes the HMI to shutdown immediately. If the board being shut down is the primary board, no HMI backup request is performed, since shutting down does not change the status of the board. If the user wishes an immediate switchover prior to shutdown of the primary board, an HMI backup request should be issued before the shutdown request and an HMI primary request should 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.

(Page 7 of 11 in this chapter) Version

tech_support@nmss.com

Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.