Mac OS 9
ShutDown.h File Reference

Shutdown Manager Interfaces. More...

#include <MacTypes.h>
#include <MixedMode.h>

Go to the source code of this file.

Macros

#define NewShutDwnUPP(userRoutine)
 
#define DisposeShutDwnUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define InvokeShutDwnUPP(shutDownStage, userUPP)    CALL_ONE_PARAMETER_UPP((userUPP), uppShutDwnProcInfo, (shutDownStage))
 
#define NewShutDwnProc(userRoutine)   NewShutDwnUPP(userRoutine)
 
#define CallShutDwnProc(userRoutine, shutDownStage)    InvokeShutDwnUPP(shutDownStage, userRoutine)
 

Enumerations

enum  {
  sdOnPowerOff = 1 , sdOnRestart = 2 , sdOnUnmount = 4 , sdOnDrivers = 8 ,
  sdOnBootVolUnmount = 16 , sdRestartOrPower = 3
}
 
enum  { uppShutDwnProcInfo = 0x00001002 }
 

Functions

typedef CALLBACK_API_REGISTER68K (void, ShutDwnProcPtr,(short shutDownStage))
 
typedef REGISTER_UPP_TYPE (ShutDwnProcPtr) ShutDwnUPP
 
ShutDwnUPP NewShutDwnUPP (ShutDwnProcPtr userRoutine)
 
void DisposeShutDwnUPP (ShutDwnUPP userUPP)
 
void InvokeShutDwnUPP (short shutDownStage, ShutDwnUPP userUPP)
 
void ShutDwnPower (void)
 Perform housekeeping and turn off the power. More...
 
void ShutDwnStart (void)
 Perform housekeeping and reboot. More...
 
void ShutDwnInstall (ShutDwnUPP shutDownProc, short flags)
 
void ShutDwnRemove (ShutDwnUPP shutDownProc)
 

Detailed Description

Shutdown Manager Interfaces.

Introduced In: System 7.5
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1987-2001 by Apple Computer, Inc., all rights reserved

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Macro Definition Documentation

◆ NewShutDwnProc

#define NewShutDwnProc (   userRoutine)    NewShutDwnUPP(userRoutine)

CALL_NOT_IN_CARBON support for pre-Carbon UPP routines: New...Proc and Call...Proc

◆ NewShutDwnUPP

#define NewShutDwnUPP (   userRoutine)
Value:
(ShutDwnUPP) NewRoutineDescriptor( \
(ProcPtr)(userRoutine), uppShutDwnProcInfo, GetCurrentArchitecture())
UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

register no_return_value Func(2_bytes:D0)

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
sdOnRestart 

call procedure before power off.

sdOnUnmount 

call procedure before restart.

sdOnDrivers 

call procedure before unmounting.

sdOnBootVolUnmount 

call procedure before closing drivers.

sdRestartOrPower 

call procedure before unmounting boot volume and VM volume but after unmounting all other volumes

Function Documentation

◆ DisposeShutDwnUPP()

void DisposeShutDwnUPP ( ShutDwnUPP  userUPP)

DisposeShutDwnUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ InvokeShutDwnUPP()

void InvokeShutDwnUPP ( short  shutDownStage,
ShutDwnUPP  userUPP 
)

InvokeShutDwnUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ NewShutDwnUPP()

ShutDwnUPP NewShutDwnUPP ( ShutDwnProcPtr  userRoutine)

NewShutDwnUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ ShutDwnInstall()

void ShutDwnInstall ( ShutDwnUPP  shutDownProc,
short  flags 
)

ShutDwnInstall()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ ShutDwnPower()

void ShutDwnPower ( void  )

Perform housekeeping and turn off the power.

CALL_NOT_IN_CARBON

ShutDwnPower executes system and application-specific housekeeping and
turns off the computer.
Note
If the system must be manually toggled off, ShutDwnPower presents the
user with an alert.
Copyright: THINK Reference © 1991-1992 Symantec Corporation
Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ ShutDwnRemove()

void ShutDwnRemove ( ShutDwnUPP  shutDownProc)

ShutDwnRemove()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ ShutDwnStart()

void ShutDwnStart ( void  )

Perform housekeeping and reboot.

ShutDwnStart executes system and application-specific housekeeping and
reboots the computer.
Note
ShutDwnStart results in a Reset instruction and a jump to ROM boot
code.
Copyright: THINK Reference © 1991-1992 Symantec Corporation
Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available