* * 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
Shutdowns or restarts a computer.
Syntax
n = PC_ShutDown(sComputer, sMsg, nReboot, nNumSec, nForce)
Returns
Return a number
If the function fails, the return value is zero.
If the function succeeds, the return value is nonzero.
Parameters
Name |
Type |
Optional |
Meaning |
sComputer |
String |
The name of the computer to shutdown. To use local computer, use and empty string or $PC_SD_MY_PC equate. |
|
sMsg |
String |
A message text to show |
|
nReboot |
Number |
One of the following equates: %PC_SD_REBOOT %PC_SD_DONOT_REBOOT |
|
nNumSec |
Number |
Seconds of delay before shutdown or reboot. |
|
nForce |
Number |
One of the following equates: %PC_SD_FORCE %PC_SD_DONOT_FORCE |
Remarks
Restrictions
See also
PC Module, PC_PreventShutDown, PC_RestartDialog
Examples
PC_ShutDown($PC_SD_MY_PC, _
"System ShutDown ...", _
%PC_SD_DONOT_REBOOT, _
7, _
%PC_SD_DONOT_FORCE)
