gc_AlarmSourceObjectNameToID( )

---

Termination Events | Cautions | Errors | Example | See Also

Name:	int gc_AlarmSourceObjectNameToID(aso_name, aso_id)
Inputs:	char *aso_name	pointer to alarm source object name
	unsigned long *aso_id	pointer to destination for 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_AlarmSourceObjectNameToID( ) function converts the alarm source object (ASO) name to the ASO ID. This function is used to obtain the ASO ID when the name of the alarm source object is known. The ASO ID can then be used in other functions that require the ASO ID as an input.

Parameter	Description
aso_name	points to the location of ASO name. The aso_name cannot be NULL.
aso_id	points to the destination where the alarm source object ID is returned. The aso_id cannot be NULL.

Termination Events

None

Cautions

None

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> 
    unsigned long  aso_id;
    int            rc; 
    rc = gc_AlarmSourceObjectNameToID("Springware E1", &aso_id);
    if (rc < 0)
    {
         /* get and process the error */
    }
    else 
    {
         printf("Alarm source object ID for Springware E1 is %d\n", aso_id);
    } 

See Also

• gc_AlarmSourceObjectIDToName( )

Click here to contact Telecom Support Resources