Technical Reference: Base Operating System and Extensions , Volume 2

vmgetinfo Subroutine

Purpose

Retrieves Virtual Memory Manager information.

Library

Standard C Library (libc.a)

Syntax

#include <sys/vminfo.h>

int vmgetinfo(void *out, int command, int arg)

Description

The vmgetinfo subroutine returns the current value of certain Virtual Memory Manager parameters.

Implementation Specifics

This subroutine is part of the Base Operating System (BOS) Runtime.

Parameters

arg	Additional parameter which depends on the command parameter.
command	Specifies which information should be returned. The command parameter has the following valid value: *VMINFO* The content of vminfo structure (described in sys/vminfo.h) is returned. out should point to a struct vminfo and arg should be the size of this structure. The smaller of arg or sizeof (struct vminfo) will be copied.
out	Specifies the address where VMM information should be returned.

Return Values

If the vmgetinfo subroutine is successful, a value of 0 is returned. Otherwise, a value of -1 is returned, and the errno global variable is set to indicate the error.

Error Codes

The vmgetinfo does not succeed if the following are true:

EFAULT	The copy operation to the buffer was not successful.
ENOSYS	The command parameter is not valid (or not yet implemented).