CA_Stop_CA()

Purpose

Requests the custom server control program to stop the execution of a custom server.

Libraries

Blueworx Voice Response library (libvae.a)

Custom Server library (libca.a)

Syntax

#include "CA_header.h"
int CA_Stop_CA (
 char  *application_name
);

Description

This subroutine sends a signal to the specified custom server to indicate a termination request had been issued. The termination function (if any) is called, and the server is detached from all shared resources.

Parameters

application_name

The name of the custom server to stop. The maximum number of characters allowed in this string is MAX_CA_NAME_LENGTH.

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_NOT_INIT
CA_NOT_STARTED
CA_STOP_FAILED
CA_TERMINATING

Related information

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