discussion/ml_discussion.h

   1 /* Monolith discussion widget.
   2  * - by Richard W.M. Jones <rich@annexia.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the Free
  16  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  *
  18  * $Id: ml_discussion.h,v 1.4 2003/02/22 15:34:29 rich Exp $
  19  */
  20
  21 #ifndef ML_DISCUSSION_H
  22 #define ML_DISCUSSION_H
  23
  24 #include <monolith.h>
  25
  26 struct ml_discussion;
  27 typedef struct ml_discussion *ml_discussion;
  28
  29 /* Function: new_ml_discussion - monolith discussion widget
  30  *
  31  * This is the monolith discussion widget. It is a versatile, threaded
  32  * bulletin board system modelled loosely on Usenet.
  33  *
  34  * The schema for this widget can be found in
  35  * @code{sql/ml_discussion_create.sql}.
  36  *
  37  * @code{new_ml_discussion} creates a new discussion widget. @code{pool}
  38  * is the pool for allocations, @code{session} is the current session, and
  39  * @code{dhf} is a database handle factory. @code{res_name} is the name
  40  * of the newsgroup (from the @code{ml_resources} table).
  41  *
  42  * The function returns the discussion widget, or @code{NULL} if there
  43  * was a problem, such as the newgroup not existing.
  44  *
  45  * See also: @ref{new_ml_discussion_panel(3)}.
  46  */
  47 extern ml_discussion new_ml_discussion (pool, ml_session, const char *conninfo, const char *res_name);
  48
  49 #endif /* ML_DISCUSSION_H */