gc_AlarmSourceObjectName( )

---

Termination Events | Cautions | Errors | Example | See Also

Name:	int gc_AlarmSourceObjectName(metaeventp, aso_name)
Inputs:	METAEVENT *metaeventp	pointer to metaevent
	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_AlarmSourceObjectName( ) function returns the alarm source object (ASO) name of the current alarm event. The function is used after a GCEV_ALARM event is received to retrieve the alarm source object name. The information retrieved by the function can be used in reports or for screen display.

Parameter	Description
metaeventp	points to metaevent
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

• The gc_AlarmSourceObjectName( ) function can only be called for GCEV_ALARM events.
• The data that is to be retrieved by the gc_AlarmSourceObjectName( ) function is valid only until the next event is requested.
• 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> 
    METAEVENT      metaevent;
    char           *aso_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_AlarmSourceObjectName(&metaevent, &aso_name);
    if (rc < 0)
    {
         /* get and process the error */
    }
    else 
    {
         printf("Alarm source object name is %s\n", aso_name);
    } 

See Also

None

Click here to contact Telecom Support Resources