gc_AlarmName( )

---

Termination Events | Cautions | Errors | Example | See Also

Name:	int gc_AlarmName(metaeventp, alarm_name)
Inputs:	METAEVENT *metaeventp	pointer to metaevent
	char **alarm_name	pointer to address of pointer to alarm name
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_AlarmName( ) function returns the name of the alarm for the current alarm event. The function is used after a GCEV_ALARM event is received to retrieve the name of the alarm. The information retrieved by the function can be used in reports or for screen display. See the appropriate Global Call Technology User's Guide for a list of possible alarm names.

Parameter	Description
metaeventp	points to the metaevent
alarm_name	points to the destination for the pointer to the alarm name. The destination cannot be NULL.

Termination Events

None

Cautions

• Do not overwrite the space pointed to by alarm_name as this is private, internal space used by GCAMS.
• The gc_AlarmName( ) function can only be called for GCEV_ALARM events.
• The data that is to be retrieved by the gc_AlarmName( ) 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;
    char           *alarm_name;
    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_AlarmName(&metaevent, &alarm_name);
    if (rc < 0)
    {
           /* get and process the error */
    }
    else 
    {
           printf("Alarm name is %s\n", alarm_name);
    } 

See Also

• gc_AlarmNumber( )

Click here to contact Telecom Support Resources