Jump to content United States-English
HP.com Home Products and Services Support and Drivers Solutions How to Buy
» Contact HP
More options
HP.com home
HP-UX SNAplus2 NOF Programmers Guide: HP-UX 11i > Chapter 4 NOF API Verbs (QUERY Verbs)

QUERY_LOG_FILE

» 

Technical documentation

Complete book in PDF
» Feedback
Content starts here

 » Table of Contents

 » Index

This verb allows the application to determine the name of the file that SNAplus2 uses to record audit or error log messages, the name of the backup log file, and the file size at which log information is copied to the backup file.

VCB Structure

typedef struct query_log_file
{
AP_UINT16 opcode; /* verb operation code */
unsigned char reserv2; /* reserved */
unsigned char format; /* reserved */
AP_UINT16 primary_rc; /* primary return code */
AP_UINT32 secondary_rc; /* secondary return code */
unsigned char log_file_type; /* type of log file */
unsigned char file_name[81]; /* file name */
unsigned char backup_file_name[81]; /* backup file name */
AP_UINT32 file_size; /* log file size */
} QUERY_LOG_FILE;

Supplied Parameters

opcode

AP_QUERY_LOG_FILE

log_file_type

The type of log file being queried. Possible values are:

AP_AUDIT

Audit log file (audit messages only).

AP_ERROR

Error log file (problem and exception messages).

Returned Parameters: Successful Execution

If the verb executes successfully, SNAplus2 returns the following parameters:

primary_rc

AP_OK

secondary_rc

Not used.

file_name

Name of the log file. This parameter is an ASCII string of 1-80 characters, followed by a null (0x00) character.

If no path is included, the file is stored in the default directory for diagnostics files, /var/opt/sna; if a path is included, this is either a full path (starting with a / character) or the path relative to the default directory.

backup_file_name

Name of the backup log file. This parameter is an ASCII string of 1-80 characters, followed by a null (0x00) character.

When the log file reaches the size specified by file_size below, SNAplus2 copies the current contents of the log file to this file and then clears the log file. You can also request a backup at any time using the SET_LOG_FILE verb.

If no path is included, the file is stored in the default directory for diagnostics files, /var/opt/sna; if a path is included, this is either a full path (starting with a / character) or the path relative to the default directory.

file_size

The maximum size of the log file specified by log_file_type. When a message written to the file causes the file size to exceed this limit, SNAplus2 clears the backup log file, copies the current contents of the log file to the backup log file, and then clears the log file. This means that the maximum amount of disk space taken up by log files is approximately twice the value of file_size.

Returned Parameters: Parameter Check

If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters:

primary_rc

AP_PARAMETER_CHECK

secondary_rc
AP_INVALID_FILE_TYPE

The log_file_type parameter was not set to a valid value.

Appendix A “Common Return Codes” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.

Returned Parameters: Other Conditions

Appendix A “Common Return Codes” lists further combinations of primary and secondary return codes that are common to all NOF verbs.

Printable version
Privacy statement Using this site means you accept its terms Feedback to webmaster
© 2003 Hewlett-Packard Development Company, L.P.