DragonFly On-Line Manual Pages

ph_id(3)                        C Library Calls                       ph_id(3)

NAME
       ph_id, ph_external, ph_status - miscellaneous functions for PH server
       connections

SYNOPSIS
       #include <phclient.h>

       int ph_id(PH *ph, char *id);
       int ph_status(PH *ph, char ** motd);
       int ph_external(PH *ph);

VERSION
       This man page documents version 1.2 of libphclient.

DESCRIPTION
       The ph_id() function adds an entry to the PH server's logs containing
       the text found in id.  This is intended to be used for tracking PH
       usage.

       The ph_status() function retrieves the server's message of the day.
       The motd argument is set to point to a dynamicly-allocated string
       containing the text returned by the server.  It is then the calling
       application's responsibility to free this memory when it is no longer
       needed.

       The ph_external() function tells the server to consider the session
       non-local, even if it originated from a host which would normally be
       treated as local.

RETURN VALUE
       These functions return 0 on success.  On error, they return -1 and set
       errno.

ERRORS
       These functions may fail with any error from the functions read() or
       write().

SEE ALSO
       read(2), write(2), ph_open(3)

University of Illinois             Oct 2002                           ph_id(3)