ANSI C, C++

#include <dclog.h>
int  dc_log_audit_print(char *msgid,char *compid,DCLONG ctgry,
                        DCLONG result,DCLONG op,char *msg,DCLONG flags)

K&R C

#include <dclog.h>
int  dc_log_audit_print(msgid,compid,ctgry,result,op,msg,flags)
char      *msgid;
char      *compid;
DCLONG    ctgry;
DCLONG    result;
DCLONG    op;
char      *msg;
DCLONG    flags;

The function dc_log_audit_print() outputs to the audit log file the following information items, in addition to the information specified as arguments: header information, serial number, date and time, relevant program name, relevant process ID, location, subject identification information, object information, object location information, request sender host, and location identification information. The relevant program means the program that generated the audit log data, which is OpenTP1. If an error occurs during output of audit log data, an error message is sent to the standard error output and syslog.

In OpenTP1, numbers from 34000 to 34999 are assigned for message IDs used by the function dc_log_audit_print(). If you create a UAP, make sure that the message IDs output by the UAP are in the range from 34000 to 34999.

For details on the items output as audit log data, see the OpenTP1 Programming Guide.

msgid

Specify an identifier uniquely assigned to each audit log entry (message ID) in the format KFCAnnnnn-x (11 characters) and follow the identifier with a null character. For nnnnn, specify a five-digit serial number in the range from 34000 to 34999. For x, specify E, W, or I as the message type according to the type of information provided by the audit log entry to be output.

compid

Specify any value that identifies the UAP that called the function dc_log_audit_print() (calling program ID). The value you set must be two numeric characters, alphabetic characters, or symbols followed by a null character. In the audit log, the format is *AA, with an asterisk (*) prefixed (AA: character string specified in compid).

ctgry

Specify one of the following values as the audit event type:

DCLOG_CTG_STARTSTOP: Audit event related to a start or stop operation

DCLOG_CTG_AUTH: Audit event related to identification or authentication

DCLOG_CTG_ACCESS: Audit event related to access control

DCLOG_CTG_CONFIG: Audit event related to the configuration definition

DCLOG_CTG_FAIL: Audit event related to failures

DCLOG_CTG_LINK: Audit event related to the linkage status

DCLOG_CTG_EXTERNAL: Audit event related to external services

DCLOG_CTG_CONTENT: Audit event related to access to important information

DCLOG_CTG_MAINTAIN: Audit event related to maintenance

DCLOG_CTG_ANORMALY: Audit event related to anomalies

DCLOG_CTG_MANAGE: Audit event related to management operation

For details on audit event types, see the manual OpenTP1 Operation.

result

Set one of the following values as the audit event result to be included in the audit log data:

DCLOG_RES_SUCCESS: Successful event

DCLOG_RES_FAIL: Failed event

DCLOG_RES_OCCUR: Event that cannot be categorized as success or failure

op

Specify the value to be included as operation information in the audit log data. Make sure that you specify one of the following reserved words according to the audit event type specified by ctgry. If you specify NULL, this item will not be included in the audit log data.

Table 2-1 Correspondence between audit event types and reserved words

msg

Specify the address of the area that contains the freely specified description to be included in the audit log data. If you specify NULL, this item will not be included in the audit log data.

You can use numeric characters, alphabetic characters, symbols, spaces, double quotation marks ("), and commas (,). The description can have a maximum of 1024 characters, and must be followed by a null character. The null terminator character is not included in the number of characters in the description.

In the log, the specified description is enclosed in double quotation marks ("). If a double quotation mark (") is included in the description, the double quotation mark is prefixed by another double quotation mark.

flags

Specify DCNOFLAGS.