In file filexfer.h:

void xfer_setaudit

(uint32 fok, char* sok, char* dok, uint32 ffail,
char* sfail, char* dfail)

Customise post-transfer auditing.

Documentation

Customise post-transfer auditing.

This function should be executed before adding a file to the transfer list. It will affect any subsequent additions to the list, but not existing items.

The arguments of this function are ordered in such a way as to allow the use of the AUDIT macro, as used in normal auditing. If any of the string arguments is NULL, the corresponding logging action will not be performed. This way you can add logging for, say, failed transfers, but not successful ones.

Please note that, unlike audit(), you cannot provide arguments to the detailed information format strings (dok and dfail). These must always contain the following two format specifiers, in order:

  1. A string (%s) specifier. This will be substituted by the user ID of the user performing the transfer.

  2. A string (%s) specifier to be substituted by the transfer filename.

It might be nice to use (loosely) the Major shorthand for successful and failed file transfers: `user <- file' for successful downloads, ` user (- file' (think of a blunt arrow) for failed downloads. For uploads, the arrow points to the right. Of course, you can always add any required information to this.

Parameters:
fok - audit type and severity for successful transfer logging.
sok - audit summary for successful transfers.
dok - audit detailed text template for successful transfers.
ffail - audit type and severity for failed transfer logging.
sfail - audit summary for failed transfers.
dfail - audit detailed text template for failed transfers.
See Also:
AUDIT, xfer_add(), xfer_addwild().

Alphabetic index



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