* * HELP & MANUAL PREMIUM PACK 4 DEMO VERSION * *
This documentation was styled with a demo skin from the Premium Pack 4 add-on for Help & Manual. The contents of the skin are encrypted and not configurable. You can only publish HM projects with this skin. You cannot edit it or change it.
This version is copyright and may only be used for local testing purposes. It may not be distributed.
Please purchase the full version of the Premium Pack to get the configurable skins and remove this notice. The package will also include the Toolbox configuration utility for Premium Pack skins.
Description
The PC_SuspendState() function provides a quick way to suspend (sleep) or hibernate (S4) the PC.
Syntax
PC_SuspendState(nHibernate AS NUMBER,
nForceCritical AS NUMBER,
nDisableWakeEvent AS NUMBER) AS NUMBER
Returns
Return a number
If the function fails, the return value is zero.
If the function succeeds, the return value is nonzero.
Parameters
nHibernate AS NUMBER
If this parameter is nonzero, the system hibernates. If the parameter is zero, the system is suspended.
You can use the following predefined constants:
%PC_SS_HIBERNATE_ON, %PC_SS_HIBERNATE_OFF.
nForceCritical
If this parameter is nonzero, the system suspends operation immediately; if it is zero it request to each application the permission to suspend operation.
You can use the following predefined constants:
%PC_SS_FORCECRITICAL_ON, %PC_SS_FORCECRITICAL_OFF.
nDisableWakeEvent
If this parameter is nonzero, the system disables all wake events. If the parameter is zero, any system wake events remain enabled.
You can use the following predefined constants:
%PC_SS_DISABLEWAKEEVENT_ON, PC_SS_DISABLEWAKEEVENT_OFF.
Remarks
Restrictions
See also
Examples
PC_SuspendState()
