In file mail.h:

struct clubheader

Club header.

[more]char club[16]
Name of the club
[more]uint32 magic
Magic number (CLUBHEADER_MAGIC)
[more]char reserved[12]
For future expansion
[more]uint32 clubid
Number of the club
[more]char descr[64]
Club description
[more]char clubop[24]
Main club operator
[more]uint32 crdate
Club creation date
[more]uint32 crtime
Club creation time
[more]uint32 msgno
Highest message number
[more]uint32 nmsgs
Number of messages
[more]uint32 nper
Number of periodic messages
[more]uint32 nblts
Number of bulletins
[more]uint32 nfiles
Number of files
[more]uint32 nfunapp
Number of unapproved files
[more]bbskey_t keyreadax
Key required for read access
[more]bbskey_t keydnlax
Key required for download access
[more]bbskey_t keywriteax
Key required for write access
[more]bbskey_t keyuplax
Key required for upload access
[more]uint32 flags
Club options
[more]int32 msglife
Message lifetime
[more]int32 postchg
Charge for posting
[more]int32 uploadchg
Charge for uploading
[more]int32 dnloadchg
Charge for downloading
[more]int32 credspermin
Credits*100 mins, -1=default
[more]char export_access_list[128]
Allow/deny access list


Documentation

Club header.

This structure describes all aspects club, except per-user access levels (except except Club operator accesses), the club's banner and messages. This really is a biggy. Allrighty, here goes:

club
Short name of the club.
magic
A magic number (CLUBHEADER_MAGIC).
reserved
...for future expansion.

clubid
A unique integer identifying this club. Historically, the Major BBS stored its club headers in a statically allocated array, which imposed a (usually quite low) limit on the maximum number of clubs. The club ID was used as an index in that array. Megistos doesn't do this (I'm not that lazy), but the (braindead, IMHO) QWK format still needs club indices.

descr
A 63-character short description of the club. Typically describes the club's content, or gives the club motto. It's usually displayed right next to the club's name, if there's space.

clubop
The user ID of the main club's operator (ClubOP). At least one user must be associated with the club in this way. Further (identically privileged) clubops may be added by setting their individual access levels in the club.

crdate, crtime
Old-style club creation date and time. We kept these in view of the eventual migration to a 64-bit time_t.

msgno
Highest message number in this club.

nmsgs
Number of messages existing in the club at the time of the last cleanup.

nper
Number of periodic messages existing in the club at the time of the last cleanup.

nblts
Number of bulletins associated with the club at the time of the last cleanup.

nfiles
Number of files in the club at the time of the last cleanup. Approved and unapproved files are included in this count.

nfunapp
Number of unapproved files in the club at the time of the last cleanup.

keyreadax
Key needed to read this club (or, indeed, see it in lists).

keydnlax
Key needed to download files from this club.

keywriteax
Key needed to write messages in this club.

keyuplax
Key needed to upload files to this club.

flags
Flags describing this club, as a set of CLF_x constants.

postchg
Charge (in credits) for posting a message to this club. Can be negative, in which case users get rewarded.

uploadchg
Charge (in credits) for uploading a file to this club. Can be negative, in which case users get rewarded.

dnloadchg
Charge (in credits) for downloading a file to this club. Can be negative, in which case users get rewarded.

credspermin
Credits per 100 minutes spent while the user is in the club. To charge 2.5 credits per minute, set this field to 250. Negative values reward the user. Zero means being in the club consumes no credits. A special case: -1 is the default credit consumption rate for the Clubs module.

export_access_list
Access control list for networked clubs. This string specifies which remote systems can or can't access this club.

ochar club[16]
Name of the club

ouint32 magic
Magic number (CLUBHEADER_MAGIC)

ochar reserved[12]
For future expansion

ouint32 clubid
Number of the club

ochar descr[64]
Club description

ochar clubop[24]
Main club operator

ouint32 crdate
Club creation date

ouint32 crtime
Club creation time

ouint32 msgno
Highest message number

ouint32 nmsgs
Number of messages

ouint32 nper
Number of periodic messages

ouint32 nblts
Number of bulletins

ouint32 nfiles
Number of files

ouint32 nfunapp
Number of unapproved files

obbskey_t keyreadax
Key required for read access

obbskey_t keydnlax
Key required for download access

obbskey_t keywriteax
Key required for write access

obbskey_t keyuplax
Key required for upload access

ouint32 flags
Club options

oint32 msglife
Message lifetime

oint32 postchg
Charge for posting

oint32 uploadchg
Charge for uploading

oint32 dnloadchg
Charge for downloading

oint32 credspermin
Credits*100 mins, -1=default

ochar export_access_list[128]
Allow/deny access list

Alphabetic index



This page was generated with the help of DOC++.