SYS_GETPARMS sysconfig Operation

Purpose

Copies the system parameter structure into a user-specified buffer.

Description

The SYS_GETPARMS sysconfig operation copies the system parameter var structure into a user-allocated buffer. This structure may be used for informational purposes alone or prior to setting specific system parameters.

In order to set system parameters, the required fields in the var structure must be modified, and then the SYS_SETPARMS (SYS_SETPARMS sysconfig Operation) operation can be called to change the system run-time operating parameters to the desired state.

The parmp parameter on the sysconfig subroutine points to a buffer that is to contain all or part of the var structure defined in the sys/var.h file. The fields in the var_hdr part of the var structure are used for parameter update control.

The parmlen parameter on the system call should be set to the length of the var structure or to the number of bytes of the structure that is desired. The complete definition of the system parameters structure can be found in the sys/var.h file.

Return Values

The SYS_GETPARMS operation returns a value of -1 if an error occurs and the errno global variable is set to one of the following error codes.

Error Codes

Item Description
EACCES The calling process does not have the required privilege.
EFAULT The calling process does not have sufficient authority to access the data area described by the parmp and parmlen parameters provided on the subroutine. This error is also returned if an I/O error occurred when accessing data in this area.

File

Item Description
sys/var.h Contains structure definitions.