gc_AlarmNumber( )

---

Termination Events | Cautions | Errors | Example | See Also

Name:	int gc_AlarmNumber(metaeventp, alarm_number)
Inputs:	METAEVENT *metaeventp	pointer to metaevent
	long *alarm_number	pointer to location for storing the alarm number
Returns:	0 if successful <0 if failure
Includes:	gclib.h gcerr.h
Category:	GCAMS
Mode:	synchronous
Platform and Technology:	Springware: T-1/E-1, ISDN DM3: T-1/E-1, ISDN IP (host-based stack)

Description

The gc_AlarmNumber( ) function returns the alarm number for the current alarm event. The function is used to retrieve the alarm number after a GCEV_ALARM event is received. The information retrieved by the function can be used in reports or for screen display.

Parameter	Description
metaeventp	points to the metaevent
alarm_number	points to the destination for the alarm number. The destination cannot be NULL.

Termination Events

None

Cautions

• The gc_AlarmNumber( ) function can only be called for GCEV_ALARM events.
• The data that is to be retrieved by the gc_AlarmNumber( ) function is valid only until the next event is requested.

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 <stdlib.h>
#include <gclib.h>
#include <gcerr.h> 
    METAEVENT      metaevent;
    long           alarm_number;
    int            rc; 
/*
-- This code assumes that the current event is GCEV_ALARM
-- event and that gc_GetMetaEvent() has already been called
-- to place the current event information into metaevent
*/ 
    rc = gc_AlarmNumber(&metaevent, &alarm_number);
    if (rc < 0)
    {
         /* get and process the error */
    }
    else 
    {
         printf("Alarm nunber is %d\n", alarm_number);
    } 

See Also

• gc_AlarmName( )
• gc_AlarmNumberToName( )

Click here to contact Telecom Support Resources