gc_AlarmSourceObjectID( )

---

Termination Events | Cautions | Errors | Example | See Also

Name:	int gc_AlarmSourceObjectID(metaeventp, aso_id)
Inputs:	METAEVENT *metaeventp	pointer to metaevent
	unsigned long *aso_id	pointer to where to store alarm source object ID
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_AlarmSourceObjectID( ) function returns the alarm source object (ASO) ID for the current alarm event. The function is used to retrieve the ASO ID 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 metaevent
aso_id	points to the destination for the alarm source object ID. The destination cannot be NULL.

Termination Events

None

Cautions

• The gc_AlarmSourceObjectID( ) function can only be called for GCEV_ALARM events.
• The data that is to be retrieved by the gc_AlarmSourceObjectID( ) 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;
    unsigned long    aso_id;
    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_AlarmSourceObjectID(&metaevent, &aso_id);
    if (rc < 0)
    {
         /* get and process the error */
    }
    else 
    {
         printf("Alarm source object ID is %d\n", aso_id);
    } 

See Also

None

Click here to contact Telecom Support Resources