Purpose
Receive a message
from another Blueworx Voice Response component.
Libraries
Blueworx Voice Response library
(libvae.a)
Custom Server library (libca.a)
Syntax
#include "CA_header.h"
int CA_Receive_DT_Msg (
DT_MSG_INFO_ST *dt_msg_info_sp,
int wait_flag
);
Description
This subroutine
receives a message from another Blueworx Voice Response component.
Following
this subroutine, call CA_Get_DT_Parameters() to receive the data sent.
Parameters
- dt_msg_info_sp
- A pointer to a DT_MSG_INFO_ST output structure that is filled
in on return as described in DT_MSG_INFO_ST.
- wait_flag
- Specifies what actions to take if there are currently no messages
waiting:
- If CA_NOWAIT is set, the subroutine returns a value of -1 and
sets the global error number CA_errno to
CA_NO_MSG_RECV.
- If CA_WAIT is set, the subroutine will suspend execution until
a message is received.
Return codes
- 0
- Successful
- -1
- Unsuccessful (global error number CA_errno is
set to indicate the error)
Error names
CA_ACCESS_NOBUFS
CA_INV_ADDR
CA_INV_FUNC_ID
CA_NO_MSG_RECV
CA_NOT_INIT
CA_SIGNAL_RECEIVED
CA_TERMINATING