Skip to content
CapaSystems Docs

OSD\_ShutdownPC()

VB Scripting Library > OSD Scripting Library > OSD functions (OSD)

OSD_ShutdownPC()

Section titled “OSD_ShutdownPC()”

Forces the computer to shutdown.
This can be used to abort the OS deployment process if needed.

Arguments

Section titled “Arguments”

No arguments provided.

Return Type

Section titled “Return Type”

Boolean, TRUE if function completed successfully.

Remarks

Section titled “Remarks”

Example

Section titled “Example”

The following example checks if the computers chassis type is a server, and then prompts the user that this is not allowed and shuts down the computer.

Private Function IncludeScript(sScriptFile)
 '...
End Function


'Begin
  bStatus=True
  If bStatus Then bStatus=IncludeScript("customlib.cis")
  If bStatus Then bStatus=IncludeLibrary("Capalib.cin")
  If bStatus Then bStatus=IncludeLibrary("Osdlib.cin")
  If bStatus Then bStatus=Job_Start("WS","Script Name","1.0","ScriptName.log","INSTALL")
  If bStatus Then bStatus=OSD_Initialize()


  If gbIsServer Then
    If bStatus Then bStatus=Dialog_ShowWarning("It is not allowed to install images on server hardware" & vbCrLf & "Shutting down!")
    If bStatus Then bStatus=OSD_ShutdownPC()
  End If
  Job_End(bStatus)
'End main

See Also

Section titled “See Also”

Scripting Guidelines, OSD_IsServer, Dialog_ShowWarning