[ Previous | Next | Contents | Glossary | Home | Search ]
AIX Version 4.3 Base Operating System and Extensions Technical Reference, Volume 1

pm_control_state System Call

Purpose

Controls and queries the PM state.

Syntax

#include <pm.h>
int 
pm_control_state (ctrl, arg);
int ctrl;
caddr_t arg;

Parameters

ctrl Specifies the function to be performed. It is one of the following values:
PM_CTRL_QUERY_SYSTEM_STATE
Queries the PM state.
PM_CTRL_START_SYSTEM_STATE
Initiates the PM state change.
arg Specifies a pointer to the following pm_system_state_t structure: 
struct _pm_system_state {
   int state;              /*system PM state*/
   int event;              /*resume event*/
   char name[16];          /*device name which caused an error*/
   char reserve[8];        /*reserved*/
} pm_system_state_t;
The state value is one of the following:
PM_SYSTEM_FULL_ON System full on
PM_SYSTEM_ENABLE System PM enable
PM_SYSTEM_STANDBY System standby
PM_SYSTEM_SUSPEND System suspend
PM_SYSTEM_HIBERNATION System hibernation
PM_TRANSITION_START Transition request started
PM_TRANSITION_END Transition request completed
The event value is one of the following:
PM_EVENT_POWER_SWITCH_ON
PM_EVENT_LID_OPEN
PM_EVENT_RTC
PM_EVENT_RING
PM_EVENT_MOUSE
PM_EVENT_KEYBOARD
PM_EVENT_EXTRA_INPUTDD
PM_EVENT_EXTRA_BUTTON
PM_EVENT_REJECT_BY_HIB_VOL
PM_EVENT_NOT_SUPPORTED
PM_EVENT_GENERAL_ERROR
PM_EVENT_REJECT_BY_DD
Note: The functions at AIX 4.1.1 still remain as they were. But they are left only for backward compatibility and may be deleted in the future. New programs should not use them.

Description

The pm_control_state system call controls and queries the PM state.

Return Values

PM_SUCCESS Indicates successful completion.
PM_ERROR Indicates an error condition. The variable errno is set to identify the error.

Error Codes

EINVAL Invalid argument.

Implementation Specifics

The pm_control_state system call is part of the Base Operation System (BOS) Runtime.

Related Information

The pm_control_parameter system call, pm_battery_control system call, pm_system_event_query system call.

[ Previous | Next | Contents | Glossary | Home | Search ]