hmiStop

Disables communications to the TX board and sends an HMI_EVN_STOP event to all applications that are registered to receive unsolicited status events. Call this function upon receipt of an HMI_EVN_EXTRACT event, indicating that a board is to be removed.

Prototype

DWORD hmiStop ( CTAHD ctahd )

Argument

Description

ctahd

Natural Access handle returned by ctaOpenServices.


Return values

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.