(Page 11 of 11 in this chapter) Version

hmiStop

Description

Disables communications to the TX board and sends an HMI_EVN_STOP event to all applications that are registered to received unsolicited status events.

Prototype

DWORD hmiStop ( CTAHD ctahd )
ctahd CT Access handle returned by ctaOpenServices.

Return Values

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

Details

This function should be called upon receipt of an HMI_EVN_EXTRACT event, indicating a board is to be removed.

(Page 11 of 11 in this chapter) Version

tech_support@nmss.com

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