(Page 6 of 11 in this chapter) Version

hmiReset

Description

Requests the local HMI service to read the configuration file again.

Prototype

DWORD hmiReset (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

All existing application connections are preserved during a reset.
A reset causes the HMI to re-read its configuration file, so editing the HMI configuration file and issuing a reset request is one way to reconfigure. However, the ports assigned to the HMI are not reconfigured on a reset - the HMI must be stopped and restarted to change ports.

(Page 6 of 11 in this chapter) Version

tech_support@nmss.com

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