SA_ServeRestartingPage

  • Article

Server Appliance Kit

This function serves a page that indicates that the server appliance is currently unavailable, restarting, or shutting down. This function does not restart the server appliance.

  
    SA_ServeRestartingPage(
ByVal 
    strOption
    , 
ByVal sInitialWait, 
ByVal sRetryWait, 
ByVal strRsrcDLL,
ByVal sTitleRID,
ByVal sMessageRID
)

Parameters

  • strOption
    Specifies one of the optional standard restart options, as shown in the following table. If one of these standard options is specified, strRsrcDLL, sTitleRID, and sMessageRID do not need to be specified and SA_DEFAULT can be specified.

    Option Description
    Shutdown The server appliance will perform a shutdown.
    Restart The server appliance will perform a restart.

  • sInitialWait
    Time (in milliseconds) that this page will wait before checking to determine whether the appliance has completed a restart.

  • sRetryWait
    Optional. Time (in milliseconds) that, following the initial delay, this page will wait before attempting to reconnect to the server appliance while a restart is in progress. If this is not specified, the default value indicated by the registry key HKLM\SOFTWARE\Microsoft\ServerAppliance\WebFramework\RestartRetryDelay is used.

  • strRsrcDLL
    Optional. String resource dynamic-link library (DLL) that contains string message text for the sTitleRID and sMessageRID parameters.

  • sTitleRID
    Optional title resource identifier for the title that should be used for this page if the restarting option is not one of the standard options.

  • sMessageRID
    Optional message resource identifier for the message that should be used for this page if the restarting option is not one of the standard options.

Return Values

None.

Remarks

The following code sample illustrates how to use this function.

  '
'Show the restarting page, wait the default amount of time before 
'checking for the server appliance to come back up
'and then check at the default interval.
'
Call SA_ServeRestartingPage("Restarting", "SA_DEFAULT", "SA_DEFAULT", _
                            SA_DEFAULT, SA_DEFAULT, SA_DEFAULT)

Requirements

Runs on Versions Defined in Include Link to
Server (ASP), VBScript Microsoft Server Appliance Kit 3.0   inc_framework.asp  

Note

  • This function is part of the complete Server Appliance Kit as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM), and some devices might not support this function.S