VxWorks Reference Manual : Libraries

m2IcmpLib

NAME

m2IcmpLib - MIB-II ICMP-group API for SNMP Agents

ROUTINES

m2IcmpInit( ) - initialize MIB-II ICMP-group access
m2IcmpGroupInfoGet( ) - get the MIB-II ICMP-group global variables
m2IcmpDelete( ) - delete all resources used to access the ICMP group

DESCRIPTION

This library provides MIB-II services for the ICMP group. It provides routines to initialize the group, and to access the group scalar variables. For a broader description of MIB-II services, see the manual entry for m2Lib.

USING THIS LIBRARY

This library can be initialized and deleted by calling the routines m2IcmpInit( ) and m2IcmpDelete( ) respectively, if only the ICMP group's services are needed. If full MIB-II support is used, this group and all other groups can be initialized and deleted by calling m2Init( ) and m2Delete( ).

The group scalar variables are accessed by calling m2IcmpGroupInfoGet( ) as follows:

    M2_ICMP   icmpVars;

    if (m2IcmpGroupInfoGet (&icmpVars) == OK)
        /* values in icmpVars are valid */

INCLUDE FILES

m2Lib.h

SEE ALSO

m2IcmpLib, m2Lib, m2IfLib, m2IpLib, m2TcpLib, m2SysLib

---

Libraries : Routines

m2IcmpInit( )

NAME

m2IcmpInit( ) - initialize MIB-II ICMP-group access

SYNOPSIS

STATUS m2IcmpInit (void)

DESCRIPTION

This routine allocates the resources needed to allow access to the MIB-II ICMP-group variables. This routine must be called before any ICMP variables can be accessed.

RETURNS

OK, always.

SEE ALSO

m2IcmpLib, m2IcmpGroupInfoGet( ), m2IcmpDelete( )

---

Libraries : Routines

m2IcmpGroupInfoGet( )

NAME

m2IcmpGroupInfoGet( ) - get the MIB-II ICMP-group global variables

SYNOPSIS

STATUS m2IcmpGroupInfoGet
    (
    M2_ICMP * pIcmpInfo /* pointer to the ICMP group structure */
    )

DESCRIPTION

This routine fills in the ICMP structure at pIcmpInfo with the MIB-II ICMP scalar variables.

RETURNS

OK, or ERROR if the input parameter pIcmpInfo is invalid.

ERRNO

S_m2Lib_INVALID_PARAMETER

SEE ALSO

m2IcmpLib, m2IcmpInit( ), m2IcmpDelete( )

---

Libraries : Routines

m2IcmpDelete( )

NAME

m2IcmpDelete( ) - delete all resources used to access the ICMP group

SYNOPSIS

STATUS m2IcmpDelete (void)

DESCRIPTION

This routine frees all the resources allocated at the time the ICMP group was initialized. The ICMP group should not be accessed after this routine has been called.

RETURNS

OK, always.

SEE ALSO

m2IcmpLib, m2IcmpInit( ), m2IcmpGroupInfoGet( )