Navigation:  thinBasic Modules > PC > PC Control functions >

PC_ShutDown

Previous pageReturn to chapter overviewNext page

 

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