CA_Get_Profile_List()

Purpose

Retrieves application profile IDs and names.

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_Profile_List (
 PROFILE_LIST_PARM_ST  *profile_list_parm_sp,
 unsigned long         profile_count,
 PROFILE_LIST_ST       profile_list_array []
);

Description

This subroutine returns the application profile ID, digit name, and name for all the application profiles that meet the input criteria.

The criteria are starting profile ID, ending profile ID, profile count, and state table name. If no criteria are specified, data for all the application profiles is returned. The returned list is sorted by application profile name, then ID.

The calling routine also specifies the number of profiles to be retrieved in the profile_count field. The area allocated for the profile_list_array must be large enough to accommodate this number of entries.

By calling the CA_Get_Profile_Count() routine first, the calling routine can call this routine multiple times to retrieve all data.

The returned data will be passed back in a structure array previously defined by the calling routine.

Parameters

profile_list_parm_sp

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

profile_count

Number of application profiles to retrieve. The range of this parameter is 1 to USHRT_MAX.

profile_list_array

An array of PROFILE_LIST_ST output structures that will be filled in as described in PROFILE_LIST_ST.

Return codes

0

Successful; number of application profiles that match the specified criteria

-1

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

Error names

CA_ACCESS_NOBUFS
CA_INV_ADDR
CA_INV_PROFILE_COUNT
CA_INV_PROFILE_ID
CA_INV_PROFILE_NAME
CA_INV_REQUEST
CA_INV_STATE_TABLE_NAME
CA_NO_MSG_RECV
CA_NOT_INIT
CA_REQ_FAILED
CA_TERMINATING

Related information

CA_Create_Profile(), CA_Delete_Profile(), CA_Get_Profile(), CA_Get_Profile_Count(), CA_Set_Profile_Defaults(), CA_Update_Profile(), the Blueworx Voice Response for AIX: Designing and Managing State Table Applications information.