CA_Simulate_Alphas()

Purpose

Simulates pressing alphabetic keys.

Libraries

Blueworx Voice Response library (libvae.a)

Custom Server library (libca.a)

Syntax

#include "CA_header.h"
int  CA_Simulate_Alphas (
 CHANNEL_INFO_ST    *channel_info_sp,
 int                alpha_string_length,
 unsigned char      *alpha_string_p
);

Description

This subroutine generates simulated key presses on a given channel. The associated channel process handles these key presses exactly as if they had come from an external device.

It is similar to CA_Simulate_Keys(), but provides a simpler interface for simulating the two-character representations of alphabetic characters interpreted by the GetText state table action.

Parameters

channel_info_sp

A pointer to a CHANNEL_INFO_ST input structure that is filled in as described in CHANNEL_INFO_ST. This should contain the physical card and channel returned from a previous call to CA_Get_Channel_Info().

alpha_string_length

The number of characters from the string to send.

alpha_string_p

A pointer to a string of alphabetic characters to be sent to the given channel. Valid characters are any in the key mapping table defined by the Key Signals system parameter group, plus the CA_ENTER_KEY global variable, which is typically used to indicate the end of the key sequence.

Return codes

0

Successful

-1

Unsuccessful (global error number CA_errno is set to indicate the error)

Error names

CA_CALL_ACCESS_DENIED
CA_FUNC_FAILED
CA_INV_KEYS
CA_INV_CHANNEL
CA_NO_DEVICE
CA_NOT_INIT
CA_SIGNAL_RECEIVED
CA_TERMINATING

Related information

CA_Simulate_Hangup(), CA_Simulate_Keys().