VxWorks Reference Manual : Libraries

dhcpcShow

NAME

dhcpcShow - DHCP run-time client information display routines

ROUTINES

dhcpcShowInit( ) - initialize the DHCP show facility
dhcpcServerShow( ) - display current DHCP server
dhcpcTimersShow( ) - display current lease timers
dhcpcParamsShow( ) - display current lease parameters

DESCRIPTION

This library provides routines that display various information related to the DHCP run-time client library such as the lease timers and responding server. The dhcpcShowInit( ) routine links the show facility into the VxWorks image. This happens automatically if INCLUDE_NET_SHOW and INCLUDE_DHCPC are defined at the time the image is built.

INCLUDE FILES

dhcpcLib.h

SEE ALSO

dhcpcShow, dhcpcLib, Network Programmer's Guide: Network Configuration Protocols


Libraries : Routines

dhcpcShowInit( )

NAME

dhcpcShowInit( ) - initialize the DHCP show facility

SYNOPSIS


void dhcpcShowInit (void)

DESCRIPTION

This routine links the DHCP show facility into the VxWorks system image. It is called from usrNetwork.c automatically if INCLUDE_DHCP and INCLUDE_NET_SHOW are defined at the time the image is constructed.

SEE ALSO

dhcpcShow


Libraries : Routines

dhcpcServerShow( )

NAME

dhcpcServerShow( ) - display current DHCP server

SYNOPSIS

STATUS dhcpcServerShow
    (
    void * pCookie /* identifier returned by dhcpcInit() */
    )

DESCRIPTION

This routine prints the IP address of the DHCP server that provided the parameters for the lease identified by pCookie. It has no effect if the indicated lease is not currently active.

RETURNS

OK, or ERROR if lease identifier unknown.

ERRNO

 S_dhcpcLib_BAD_COOKIE

SEE ALSO

dhcpcShow


Libraries : Routines

dhcpcTimersShow( )

NAME

dhcpcTimersShow( ) - display current lease timers

SYNOPSIS

STATUS dhcpcTimersShow
    (
    void * pCookie /* identifier returned by dhcpcInit() */
    )

DESCRIPTION

This routine prints the time remaining with each of the DHCP lease timers for the lease identified by pCookie. It has no effect if the indicated lease is not currently active.

RETURNS

OK if show routine completes, or ERROR otherwise.

ERRNO

 S_dhcpcLib_BAD_COOKIE

SEE ALSO

dhcpcShow


Libraries : Routines

dhcpcParamsShow( )

NAME

dhcpcParamsShow( ) - display current lease parameters

SYNOPSIS

STATUS dhcpcParamsShow
    (
    void * pCookie /* identifier returned by dhcpcInit() */
    )

DESCRIPTION

This routine prints all lease parameters for the lease identified by pCookie. It has no effect if the indicated lease is not currently active.

RETURNS

OK, or ERROR if lease identifier unknown.

ERRNO

 S_dhcpcLib_BAD_COOKIE

SEE ALSO

dhcpcShow