gc_AlarmSourceObjectIDToName( )

---

Termination Events | Cautions | Errors | Example | See Also

Name:	int gc_AlarmSourceObjectIDToName(aso_id, aso_name)
Inputs:	unsigned long aso_id	destination for alarm source object ID
	char **aso_name	pointer to address of alarm source object 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_AlarmSourceObjectIDToName( ) function converts the alarm source object (ASO) ID to the ASO name. The function is used after a GCEV_ALARM event is received to convert the alarm source object ID to the name of the alarm source object. The information retrieved by the function can be used in reports or for screen display.

Parameter	Description
aso_id	alarm source object ID
aso_name	points to the location where the pointer to the alarm source object name is to be stored. The aso_name cannot be NULL.

Termination Events

None

Cautions

Do not overwrite the value that is returned in aso_name as this points to private, internal GCAMS 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 <stdlib.h>
#include <gclib.h>
#include <gcerr.h> 
    char           *aso_name;
    int            rc; 
    rc = gc_AlarmSourceObjectIDToName(ALARM_SOURCE_ID_SPRINGWARE_E1, &aso_name);
    if (rc < 0)
    {
         /* get and process the error */
    }
    else 
    {
         printf("ALARM_SOURCE_ID_SPRINGWARE_E1 name is %s\n", aso_name);
    } 

See Also

• gc_AlarmSourceObjectNameToID( )

Click here to contact Telecom Support Resources