Annotation of libwww/Library/src/HTLib.html, revision 2.2
2.1 frystyk 1: <HTML>
2: <HEAD>
2.2 ! frystyk 3: <!-- Changed by: Henrik Frystyk Nielsen, 12-Jul-1996 -->
2.1 frystyk 4: <TITLE>W3C Reference Library libwww Global Libwww Information</TITLE>
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: <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>
2.2 ! frystyk 50: Is the Library Initalized?
! 51: </H3>
! 52: <P>
! 53: Returns YES or NO
! 54: <PRE>extern BOOL HTLib_isInitialized (void);
! 55: </PRE>
! 56: <H3>
2.1 frystyk 57: Application Name and Version
58: </H3>
59: <P>
60: Returns the name of the application and the version number that was passed
61: to the <CODE>HTLibInit()</CODE> function.
62: <PRE>
63: extern const char * HTLib_appName (void);
64: extern const char * HTLib_appVersion (void);
65: </PRE>
66: <H3>
67: Accessing the Local File System
68: </H3>
69: <P>
70: The Library does normally use the local file system for dumping unknown data
71: objects, file cache etc. In some situations this is not desired and we can
72: therefore turn it off. This mode also prevents you from being able to access
73: other resources where you have to log in telnet, for example.
74: <PRE>extern BOOL HTLib_secure (void);
75: extern void HTLib_setSecure (BOOL mode);
76: </PRE>
77: <H3>
78: Default User Profile
79: </H3>
80: <P>
81: The default <A HREF="HTUser.html">user profile</A> is automatically created
82: by the libwww in order to get information about the <I>hostname</I>, default
83: <I>email -address </I>etc. All <A HREF="HTReq.html">request objects</A> will
84: be created with this default user profile. The application may assign individual
85: user profiles to every request object or may set the default user profile.
86: <PRE>extern HTUserProfile * HTLib_userProfile (void);
87: extern BOOL HTLib_setUserProfile (HTUserProfile * up);
88: </PRE>
89: <PRE>
90: #endif /* HTLIB_H */
91: </PRE>
92: <P>
93: <HR>
94: <ADDRESS>
2.2 ! frystyk 95: @(#) $Id: HTLib.html,v 2.1 1996/06/28 16:31:15 frystyk Exp $
2.1 frystyk 96: </ADDRESS>
97: </BODY></HTML>
Webmaster
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to HTLib.html CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Public] / libwww / Library / src