CA_Get_Voice_Msg_Info()

Purpose

Retrieves voice message information.

Libraries

Blueworx Voice Response library (libvae.a)

Custom Server library (libca.a)

Syntax

#include "CA_header.h"
#include "CA_access_db.h"
int CA_Get_Voice_Msg_Info (
 GET_VOICE_MSG_INFO_PARM_ST  *get_voice_msg_info_parm_sp,
 VOICE_MSG_INFO_ST           *voice_msg_info_sp
);

Description

This subroutine retrieves message information based on the information in the GET_VOICE_MSG_INFO_PARM_ST input structure. Based on the input message status and number, this routine may return sender, receiver, message status, message number, transaction ID, voice data size (in voice elements), and compression type information back to the calling routine in the VOICE_MSG_INFO_ST output structure.

Parameters

get_voice_msg_info_parm_sp

A pointer to a GET_VOICE_MSG_INFO_PARM_ST input structure that is filled in as described in GET_VOICE_MSG_INFO_PARM_ST.

voice_msg_info_sp

A pointer to a VOICE_MSG_INFO_ST output structure that will be filled in as described in GET_VOICE_MSG_PARM_ST.

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_COMPRESSION_TYPE
CA_INV_PROFILE_ID
CA_INV_MAILBOX_ID
CA_INV_MSG_NUMBER
CA_INV_MSG_STATUS
CA_INV_REQUEST
CA_INV_TRANSACTION_ID
CA_NO_MSG_RECV
CA_NOT_INIT
CA_OM_REQ_FAILED
CA_REQ_FAILED
CA_TERMINATING
CA_VOICE_MSG_NOT_FOUND

Related information

CA_Create_Voice_Msg(), CA_Create_Voice_Msg_Id(), CA_Delete_Voice_Msg(), CA_Get_Voice_Msg(), CA_Save_Voice_Msg(), CA_Send_Voice_Msg(), CA_Set_Send_Voice_Msg_Defaults().