Shell.ServiceStart method

Starts a named service.

Syntax

retVal = Shell.ServiceStart(
  sServiceName,
  vPersistent
)

Shell.ServiceStart( _
  ByVal sServiceName As BSTR, _
  ByVal vPersistent As Variant _
) As Variant

Parameters

sServiceName [in]

Type: BSTR

A String that contains the name of the service.

vPersistent [in]

Type: Variant

Set to true to have the service started automatically by the service control manager during system startup. Set to false to leave the service configuration unchanged.

Return value

JScript

Type: Variant*

Returns true if successful; otherwise, false.

VB

Type: Variant*

Returns true if successful; otherwise, false.

Remarks

The method returns false if the service has already been started. Before calling this method, you can call Shell.IsServiceRunning to ascertain the status of the service.

This method is not currently available in Microsoft Visual Basic.

Examples

The following examples show the use of ServiceStart to start the Messenger service. Usage is shown for JScript and VBScript.

JScript:

<script language="JScript">
    function fnServiceStartJ()
    {
        var objShell = new ActiveXObject("shell.application");
        var bReturn;
        
        bReturn = objShell.ServiceStart("Messenger", true);
    }

VBScript:

<script language="VBScript">
    function fnServiceStartVB()
        dim objShell
        dim bReturn

        set objShell = CreateObject("shell.application")

        bReturn = objShell.ServiceStart("Messenger", true)

        set objShell = nothing
    end function
</script>

Requirements

Minimum supported client
Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
Header
Shldisp.h
IDL
Shldisp.idl
DLL
Shell32.dll (version 5.0 or later)