gc_CCLibStatusAll( )

---

Termination Events | Cautions | Errors | Example | See Also

Name:	int gc_CCLibStatusAll(cclib_status)
Inputs:	GC_CCLIB_STATUS *cclib_status	pointer to location of library status information
Returns:	0 if successful <0 if failure
Includes:	gclib.h gcerr.h
Category:	library information
Mode:	synchronous
Platform and Technology:	All

Description

Note: The gc_CCLibStatusAll( ) function is deprecated in this software release. The suggested equivalent is gc_CCLibStatusEx( ).

The gc_CCLibStatusAll( ) function retrieves the status of all call control libraries. Information returned includes the number and names of the available, configured, and failed call control libraries. See gc_CCLibNameToID( ) for valid call control library names. The Global Call library is not a call control library and is therefore not counted.

Parameter	Description
cclib_status	points to the GC_CCLIB_STATUS structure, which contains the library status information. See GC_CCLIB_STATUS for more information.

Termination Events

None

Cautions

• If any of the num_* fields is 0, then the corresponding *libraries field is NULL; for example, if the num_avllibraries field is 0, then the avllibraries is NULL.
• Do not overwrite the fields that are pointers to strings as these point to private internal Global Call data space.

Errors

If this function returns <0 to indicate failure, use the gc_ErrorInfo( ) function to retrieve the reason for the error. See the "Error Handling" section in the Global Call API Programming Guide. All Global Call error codes are defined in the gcerr.h file. If the error returned is technology specific, see the technology-specific error header file(s) for the error definition (for example, ccerr.h or isdnerr.h file for the ISDN call control library).

Example

#include <stdio.h>
#include <srllib.h>
#include <gclib.h>
#include <gcerr.h> 
int print_all_avl_libraries(void)
{
    int             n;
    int             ret;              /* function return code */
    GC_CCLIB_STATUS cclib_status;     /* cclib information */
    GC_INFO         gc_error_info;    /* GlobalCall error information data */ 
    if (gc_CCLibStatusAll(&cclib_status) == GC_SUCCESS) {
        for (n = 0; n < cclib_status.num_avllibraries; n++) {
            printf("Next available library is: %s\n",
                    cclib_status.avllibraries[n]);
        }
    } else {
        /* process error return as shown */
        gc_ErrorInfo( &gc_error_info );
        printf ("Error: gc_CCLibStatusAll(), GC ErrorValue: 0x%hx - %s, CCLibID: %i - %s, CC ErrorValue: 0x%lx - %s\n",
               gc_error_info.gcValue, gc_error_info.gcMsg, 
               gc_error_info.ccLibId, gc_error_info.ccLibName,
               gc_error_info.ccValue, gc_error_info.ccMsg);
        return (gc_error_info.gcValue); 
    }
    return(0);
} 

See Also

• gc_CCLibStatusEx( )
• gc_Start( )

Click here to contact Telecom Support Resources