struct xfer_item

File transfer item structure (deprecated)

uint32 magic

Magic number (XFER_ITEM_MAGIC)

char dir

One of the FXM_x constants

char fullname[256]

Full path to the file

char* filename

Pointer to basename inside fullname

char description[50]

Short description of the file

uint32 auditfok

Audit flags used to log successful transfer

char auditsok[80]

Audit summary used to log successful transfer

char auditdok[80]

Audit detailed text template (used on success)

int auditffail

Audit flags used to log failed transfer

char auditsfail[80]

Audit summary used to log failed transfer

char auditdfail[80]

Audit detailed text template (failed transfer)

char cmdok[80]

Command to execute after successful transfer

char cmdfail[80]

Command to execute after failed transfer

uint32 size

File size (bytes)

int32 credspermin

Credit consumption rate (times 100)

int32 refund

Credits to refund in case of failure

uint32 flags

File transfer flags (internal use only)

int32 result

File transfer result (internal use only)

Documentation

File transfer item structure (deprecated)

This has fields for all the information needed to upload or download a file. In short, the following capabilities of the file transfer subsystem are reflected here:

• Can allow files to be downloaded (BBS to user) or uploaded (user to BBS).

• Allows user-defined auditing of both successful and failed transfers. There are separate settings for each case.

• Allows a shell command to be executed immediately after successful or failed transfers. There are two separate commands for each occasion.

• Automatically refunds the user for canceled file transfers with a charge attached.

uint32 magic

Magic number (XFER_ITEM_MAGIC)

char dir

One of the FXM_x constants

char fullname[256]

Full path to the file

char* filename

Pointer to basename inside fullname

char description[50]

Short description of the file

uint32 auditfok

Audit flags used to log successful transfer

char auditsok[80]

Audit summary used to log successful transfer

char auditdok[80]

Audit detailed text template (used on success)

int auditffail

Audit flags used to log failed transfer

char auditsfail[80]

Audit summary used to log failed transfer

char auditdfail[80]

Audit detailed text template (failed transfer)

char cmdok[80]

Command to execute after successful transfer

char cmdfail[80]

Command to execute after failed transfer

uint32 size

File size (bytes)

int32 credspermin

Credit consumption rate (times 100)

int32 refund

Credits to refund in case of failure

uint32 flags

File transfer flags (internal use only)

int32 result

File transfer result (internal use only)

Deprecated:

Do not use the structure directly. Use filexfer_t (the typedef instead.

See Also:

xfer_item_t.

Alphabetic index