CA_Get_DT_Parameters()

Purpose

Assigns parameters from a previously received message into variables.

Libraries

Blueworx Voice Response library (libvae.a)

Custom Server library (libca.a)

Syntax

#include "CA_header.h"
int CA_Get_DT_Parameters (
 DT_MSG_INFO_ST *dt_msg_info_sp,
 void *parm1,
 void *parm2,
 .
 .
 .
 void *parmN
);

Description

This subroutine is called following a CA_Receive_DT_Msg() subroutine, using the DT_MSG_INFO_ST returned. It extracts the specified parameters from the received message that corresponds to the specified function ID, from the custom server or channel process specified. The system-generated header file contains the list of possible function IDs. Each user function has a corresponding function ID of the form funcname_func_id. For example, the ID for the function x_proc() is x_proc_func_id.

Parameters

dt_msg_info_sp: A pointer to a DT_MSG_INFO_ST structure that has been returned from a previous call to CA_Receive_DT_Msg(). See DT_MSG_INFO_ST.
parmN: Each pointer (parm1, parm2, ...) points to the data area that is allocated to receive the input parameter data specified by the definitions provided in the custom server user interface.

Return codes

0: Successful
-1: Unsuccessful (global error number CA_errno is set to indicate the error)

Error names

CA_INV_ADDR
CA_INV_FUNC_ID
CA_INV_PARM_COUNT
CA_INV_PARM_TYPE
CA_MALLOC_FAILED
CA_NO_MSG_RECV
CA_NO_PARMS
CA_PARM_OVERFLOW
CA_TERMINATING

Related information

CA_Put_DT_Parameters(), CA_Receive_DT_Msg(), CA_Send_CA_Msg(), CA_Send_DT_Error(), CA_Send_DT_Msg().