Annotation of libwww/Library/src/HTLib.html, revision 2.1

2.1     ! frystyk     1: <HTML>
        !             2: <HEAD>
        !             3:   <TITLE>W3C Reference Library libwww Global Libwww Information</TITLE>
        !             4: <!-- Changed by: Henrik Frystyk Nielsen, 27-Jun-1996 -->
        !             5: </HEAD>
        !             6: <BODY>
        !             7: <H1>
        !             8:   Global Libwww Information
        !             9: </H1>
        !            10: <PRE>
        !            11: /*
        !            12: **     (c) COPYRIGHT MIT 1995.
        !            13: **     Please first read the full copyright statement in the file COPYRIGH.
        !            14: */
        !            15: </PRE>
        !            16: <P>
        !            17: This module contains some generic functions for getting the name and version
        !            18: of libwww. It also contains some global configuration options like if you
        !            19: can access the local file system, for example.
        !            20: <P>
        !            21: This module is implemented by <A HREF="HTAccess.c">HTAccess.c</A>, and it
        !            22: is a part of the <A HREF="http://www.w3.org/pub/WWW/Library/"> W3C Reference
        !            23: Library</A>.
        !            24: <PRE>
        !            25: #ifndef HTLIB_H
        !            26: #define HTLIB_H
        !            27: 
        !            28: #include "HTUser.h"
        !            29: </PRE>
        !            30: <H3>
        !            31:   <IMG SRC="../../Icons/32x32/warning"> Initializing and Terminating the Library
        !            32: </H3>
        !            33: <P>
        !            34: These two functions initiates memory and settings for the Library core and
        !            35: cleans up memory kept by the core when about to exit the application. They
        !            36: &nbsp;<B>must</B> be used!
        !            37: <PRE>extern BOOL HTLibInit (const char * AppName, const char * AppVersion);
        !            38: extern BOOL HTLibTerminate (void);
        !            39: </PRE>
        !            40: <H3>
        !            41:   Library Name and Version
        !            42: </H3>
        !            43: <P>
        !            44: You can get the generic name of the Library and the version by using the
        !            45: following functions:
        !            46: <PRE>extern const char * HTLib_name (void);
        !            47: extern const char * HTLib_version (void);
        !            48: </PRE>
        !            49: <H3>
        !            50:   Application Name and Version
        !            51: </H3>
        !            52: <P>
        !            53: Returns the name of the application and the version number that was passed
        !            54: to the <CODE>HTLibInit()</CODE> function.
        !            55: <PRE>
        !            56: extern const char * HTLib_appName (void);
        !            57: extern const char * HTLib_appVersion (void);
        !            58: </PRE>
        !            59: <H3>
        !            60:   Accessing the Local File System
        !            61: </H3>
        !            62: <P>
        !            63: The Library does normally use the local file system for dumping unknown data
        !            64: objects, file cache etc. In some situations this is not desired and we can
        !            65: therefore turn it off. This mode also prevents you from being able to access
        !            66: other resources where you have to log in telnet, for example.
        !            67: <PRE>extern BOOL HTLib_secure (void);
        !            68: extern void HTLib_setSecure (BOOL mode);
        !            69: </PRE>
        !            70: <H3>
        !            71:   Default User Profile
        !            72: </H3>
        !            73: <P>
        !            74: The default <A HREF="HTUser.html">user profile</A> is automatically created
        !            75: by the libwww in order to get information about the <I>hostname</I>, default
        !            76: <I>email -address </I>etc. All <A HREF="HTReq.html">request objects</A> will
        !            77: be created with this default user profile. The application may assign individual
        !            78: user profiles to every request object or may set the default user profile.
        !            79: <PRE>extern HTUserProfile * HTLib_userProfile (void);
        !            80: extern BOOL HTLib_setUserProfile (HTUserProfile * up);
        !            81: </PRE>
        !            82: <PRE>
        !            83: #endif /* HTLIB_H */
        !            84: </PRE>
        !            85: <P>
        !            86:   <HR>
        !            87: <ADDRESS>
        !            88:   @(#) $Id: HTAccess.html,v 2.77 1996/05/20 15:06:21 frystyk Exp $
        !            89: </ADDRESS>
        !            90: </BODY></HTML>

Webmaster