Siemens SIMATIC Ident Installation Manual page 18

Programming interface
4.1 Functions of the serial interface
ComSetNotification
comInt
With this function, a callback routine can be specified that is called if events occur in the
driver (e.g. received frame). If the "NULL" is transferred as the parameter, the routine is
disabled. This notification method can be considered as an alternative to "ComEnableEvent".
Parameter
com_handle
com_NotifCall
userID
Return value
0
< 0
ComGetReadState
comInt
This function queries the current status of the receive routine and then resets it.
Parameter
com_handle
Return value
COM_ST_FREE
COM_ST_BUSY
COM_ST_SUCCESS
< 0
Notes
● If the current status is "COM_ST_BUSY", the status is not reset.
● The error status can include several errors at the same time. Each bit in the error number
18
ComSetNotification
interface handle from
Pointer to the callback routine
User-defined ID (any value)
Function successfully completed
possible error message:
•
ComGetReadState
interface handle from
Receive routine is not busy
A frame is currently being received
A frame was successfully received
Error status
corresponds to an error. The "COM_ST_ERROR" is set in any case. Section "Error and
status messages (Page 23)" contains a precise description of the individual errors.
(comHandle_t com_handle,
comNotifCall p_callback,
int userID)
ComOpen
COM_HANDLE_FALSE
(int com_handle)
ComOpen
Installation Manual, 01/2013, J31069-D0131-U001-A2-7218
SIMATIC 3964R protocol for Windows 9x/XP/7