* Renamed "struct user" to "struct ctdluser"

[citadel.git] / citadel / techdoc / citadelapi.txt

diff --git a/citadel/techdoc/citadelapi.txt b/citadel/techdoc/citadelapi.txt
index ab5d9f334f6c3f675c1098ba77f58d449726933f..1aad5fc2a7d123fa0e68aaa4adefb188f70a89f1 100644 (file)
--- a/citadel/techdoc/citadelapi.txt
+++ b/citadel/techdoc/citadelapi.txt
@@ -18,11 +18,11 @@ the person documenting it have a chance to mature a bit.  :)
   USER RELATED FUNCTIONS
   ----------------------
  
- The fundamental user data is stored in "struct user" which is defined
+ The fundamental user data is stored in "struct ctdluser" which is defined
 in citadel.h.  The following functions are available:
   
  
- int getuser(struct user *usbuf, char name[])
+ int getuser(struct ctdluser *usbuf, char name[])
  
  Given the name of a requested user and a buffer to store the user
 record in, getuser() will search the userlog for the named user and load its
@@ -30,14 +30,14 @@ data into the buffer.  getuser() returns 0 upon success or a nonzero error
 code if the requested operation could not be performed.
  
  
- void putuser(struct user *usbuf, char *name)
+ void putuser(struct ctdluser *usbuf, char *name)
  
  After reading in a user record with getuser() and perhaps modifying the data
 in some way, a program may use putuser() to write it back to disk.
  
  
- int lgetuser(struct user *usbuf, char *name)
- void lputuser(struct user *usbuf, char *name)
+ int lgetuser(struct ctdluser *usbuf, char *name)
+ void lputuser(struct ctdluser *usbuf, char *name)
  
  If critical-section operation is required, this pair of calls may be used.
 They function the same as getuser() and putuser(), except that lgetuser()
@@ -51,14 +51,14 @@ multiple files may result in a deadlock condition which would freeze the
 entire server.
  
    
- void ForEachUser(void (*CallBack)(struct user *EachUser))
+ void ForEachUser(void (*CallBack)(struct ctdluser *EachUser))
  
  This allows a user-supplied function to be called once for each user on
 the system.  The user-supplied function will be called with a pointer to a
 user structure as its only argument.
   
  
- int getuserbynumber(struct user *usbuf, long int number)
+ int getuserbynumber(struct ctdluser *usbuf, long int number)
  
  getuserbynumber() functions similarly to getuser(), except that it is
 supplied with a user number rather than a name.  Calling this function
@@ -187,11 +187,11 @@ registered.
   FUNCTIONS WHICH MANIPULATE USER/ROOM RELATIONSHIPS
 
  void CtdlGetRelationship(struct visit *vbuf,
-                        struct user *rel_user,
-                        struct room *rel_room);
+                        struct ctdluser *rel_user,
+                        struct ctdlroom *rel_room);
  void CtdlSetRelationship(struct visit *newvisit,
-                        struct user *rel_user,
-                        struct room *rel_room);
+                        struct ctdluser *rel_user,
+                        struct ctdlroom *rel_room);
  
  These functions get/set a "struct visit" structure which may contain
 information about the relationship between a user and a room.  Specifically:
@@ -221,7 +221,7 @@ as "new messages."
  
   
  
- int CtdlRoomAccess(struct room *roombuf, struct user *userbuf)
+ int CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf)
  
  This is a convenience function which uses CtdlGetRelationship() to determine
 whether a user has access to a room.  It returns a bucket of bits which may