ProSoft Technology MVI69-ADM - Manual (Page 174)

Application Development Function Library - ADM API MVI-ADM ♦ 'C' Programmable
Developer's Guide 'C' Programmable Application Development Module
Page 174 of 342 ProSoft Technology, Inc.
February 20, 2013
ADM_SetStatus
Syntax
int ADM_SetStatus(ADMHANDLE adm_handle, ADM_INTERFACE * adm_interface_ptr, int
pass_cnt)
Parameters
adm_handle Handle returned by previous call to ADM_Open
adm_interface_ptr Pointer to ADM_INTERFACE structure to allow API access to structures
pass_cnt Counter from user code to indicate module health. This counter could be
updated in the main loop of the program.
Description
This function writes status data to the database at the location set by Error/Status
Pointer in the module configuration. The data is written in the following order:
pass_cnt (in the ADM_INTERFACE structure)
ADM_PRODUCT (structure)
ADM_PORT_ERRORS (structure, 1 time for each application port)
ADM_BLK_ERRORS (structure)
Return Value
ADM_SUCCESS The function has completed successfully.
ADM_ERR_NOACCESS adm_handle does not have access
Example
ADMHANDLE adm_handle;
ADM_INTERFACE *interface_ptr;
int pass_cnt;
ADM_INTERFACE interface;
interface_ptr = &interface;
ADM_SetStatus(adm_handle, interface_ptr, interface.pass_cnt);
See Also
ADM_SetBtStatus (page 175)