ARSetLogging

Note

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Activates and deactivates client-side logging of server activity.

If you perform a set operation on an overlay and you provide values for an inherited grain, the values are ignored. Only values for extended or overwritten grains of the overlay are set.

Privileges

Users with permission to perform client-side logging. (See Client-side ARAPILOGGING.)

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"

int ARSetLogging(
   ARControlStruct *control,
   ARULong32 logTypeMask,
   ARULong32 whereToWriteMask,
   FILE *filePtr,
   ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

logTypeMask

A bitmask that indicates the type of logging to set. This is for SQL, filter, API, and plug-in server logging. The possible values are:

Bit 1:	Database or SQL logging (`AR_DEBUG_SERVER_SQL`).
Bit 2:	Filter logging (`AR_DEBUG_SERVER_FILTER`) .
Bit 5:	API logging (`AR_DEBUG_SERVER_API`).
Bit 18:	Plug-in logging (`AR_DEBUG_SERVER_PLUGIN`).

whereToWriteMask

A value that indicates where to return log information. The possible values are

`1`:	Logs to a file (`AR_WRITE_TO_FILE`).
`2`:	Logs as part of an ARStatusList (`AR_WRITE_TO_STATUS_LIST`).

filePtr

A file handle to the log file. It is assumed the file has already been opened. A NULL value indicates that no writing be done to the file.

Return values

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error checking.

If the whereToWriteMask input parameter is set to AR_WRITE_TO_STATUS_LIST, the message number is of type messageNum (number of the status structure), and everything that is logged is of type AR_NOTE_LOG_INFO.