gc_AlarmNumberToName( )

---

Termination Events | Cautions | Errors | Example | See Also

Name:	int gc_AlarmNumberToName(aso_id, alarm_number, name)
Inputs:	unsigned long aso_id	alarm source object ID
	long alarm_number	alarm number
	char **name	pointer to address where pointer to name is to be returned
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_AlarmNumberToName( ) function converts an alarm number to a name for a specified alarm source object. This function can be used to determine the alarm name for a given alarm number.

Parameter	Description
aso_id	alarm source object (ASO) ID
alarm_number	alarm number to be converted
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 it is private, internal space used by GCAMS.

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>
#include <dtilib.h>     /* for ASO symbols */ 
    char           *alarm_name;
    int            rc; 
    rc = gc_AlarmNumberToName(ALARM_SOURCE_ID_SPRINGWARE_E1, DTE1_LOS, &alarm_name);
    if (rc < 0)
    {
         /* get and process the error */
    }
    else 
    {
         printf("Alarm name for DTE1_LOS is %s\n", alarm_name);
    } 

See Also

• gc_AlarmNumber( )

Click here to contact Telecom Support Resources