CA_Get_CA_Info()

Purpose

Get information about a custom server.

Libraries

Blueworx Voice Response library (libvae.a)

Custom Server library (libca.a)

Syntax

#include "CA_header.h"
int CA_Get_CA_Info (
 char *appl_name,
 CA_INFO_ST *ca_info_sp
);

Description

This subroutine gets the information given in a CA_INFO_ST structure for a specified custom server.

Parameters

appl_name
Specifies the name of the custom server. A #define for APPL_NAME is provided in the system-generated header file for each custom server. The maximum number of characters allowed in this string is MAX_CA_NAME_LENGTH.
ca_info_sp
A pointer to a CA_INFO_ST output structure that will be filled in as described in CA_INFO_ST. This will contain information about the specified custom server.

Return codes

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

Error names

CA_APPL_NOT_INSTALLED
CA_INV_ADDR
CA_INV_APPL
CA_INV_REQUEST
CA_NOT_INIT
CA_TERMINATING

Related information

CA_Start_CA(), CA_Stop_CA(), CA_Deinstall_CA(), CA_Delete_CA(), CA_Send_CA_Msg(), CA_Set_CA_Ipl_Status().