Function

IOPMSleepSystem

Request that the system initiate sleep.

Declaration

IOReturn IOPMSleepSystem(io_connect_t fb);

Parameters

fb

Port used to communicate to the kernel, from IOPMFindPowerManagement.

Return Value

Returns kIOReturnSuccess or an error condition if request failed.

Discussion

For security purposes, caller must be root or the console user.

See Also

Miscellaneous

IOPMAssertionTypes

Use as AssertionType argument to IOPMAssertionCreate. The idle display will not sleep when enabled, and consequently the system will not idle sleep.

IOPMCopyBatteryInfo

Request raw battery data from the system.

IOPMFindPowerManagement

Finds the Root Power Domain IOService.

IOPMGetAggressiveness

Retrieves the current value of one of the aggressiveness factors in IOKit Power Management.

IOPMSetAggressiveness

Sets one of the aggressiveness factors in IOKit Power Management.

IOPMSleepEnabled

Tells whether the system supports full sleep, or just doze

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software