StartServiceA

関数

指定したサービスを開始する。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL StartServiceA(
    SC_HANDLE hService,
    DWORD dwNumServiceArgs,
    LPCSTR* lpServiceArgVectors   // optional
);

パラメーター

名前	型	方向	説明
hService	SC_HANDLE	in	サービスへのハンドル。このハンドルは OpenService または CreateService 関数によって返され、SERVICE_START アクセス権を持っている必要があります。詳細については Service Security and Access Rights を参照してください。
dwNumServiceArgs	DWORD	in	lpServiceArgVectors 配列に含まれる文字列の数。lpServiceArgVectors が NULL の場合、このパラメーターは 0 にできます。
lpServiceArgVectors	LPCSTR*	inoptional	サービスの ServiceMain 関数に引数として渡される、null で終わる文字列。引数がない場合、このパラメーターは NULL にできます。それ以外の場合、最初の引数 (lpServiceArgVectors[0]) はサービスの名前であり、その後に追加の引数 (lpServiceArgVectors[1] から lpServiceArgVectors[dwNumServiceArgs-1] まで) が続きます。ドライバーサービスはこれらの引数を受け取りません。

名前

型

方向

説明

hService

SC_HANDLE

サービスへのハンドル。このハンドルは OpenService または CreateService 関数によって返され、SERVICE_START アクセス権を持っている必要があります。詳細については Service Security and Access Rights を参照してください。

dwNumServiceArgs

DWORD

lpServiceArgVectors 配列に含まれる文字列の数。lpServiceArgVectors が NULL の場合、このパラメーターは 0 にできます。

lpServiceArgVectors

LPCSTR*

inoptional

サービスの ServiceMain 関数に引数として渡される、null で終わる文字列。引数がない場合、このパラメーターは NULL にできます。それ以外の場合、最初の引数 (lpServiceArgVectors[0]) はサービスの名前であり、その後に追加の引数 (lpServiceArgVectors[1] から lpServiceArgVectors[dwNumServiceArgs-1] まで) が続きます。

ドライバーサービスはこれらの引数を受け取りません。

戻り値の型: BOOL

公式ドキュメント

サービスを開始します。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには GetLastError を呼び出します。

次のエラーコードはサービスコントロールマネージャーによって設定されることがあります。その他のエラーコードは、サービスコントロールマネージャーによって呼び出されるレジストリ関数によって設定されることがあります。

戻りコード	説明
ERROR_ACCESS_DENIED	ハンドルが SERVICE_START アクセス権を持っていません。
ERROR_INVALID_HANDLE	ハンドルが無効です。
ERROR_PATH_NOT_FOUND	サービスのバイナリファイルが見つかりませんでした。
ERROR_SERVICE_ALREADY_RUNNING	サービスのインスタンスが既に実行中です。
ERROR_SERVICE_DATABASE_LOCKED	データベースがロックされています。
ERROR_SERVICE_DEPENDENCY_DELETED	サービスは、存在しないか削除対象としてマークされたサービスに依存しています。
ERROR_SERVICE_DEPENDENCY_FAIL	サービスは、開始に失敗した別のサービスに依存しています。
ERROR_SERVICE_DISABLED	サービスが無効化されています。
ERROR_SERVICE_LOGON_FAILED	ログオンの失敗によりサービスが開始しませんでした。このエラーは、サービスが「サービスとしてログオン」の権利を持たないアカウントで実行するよう構成されている場合に発生します。
ERROR_SERVICE_MARKED_FOR_DELETE	サービスが削除対象としてマークされています。
ERROR_SERVICE_NO_THREAD	サービス用のスレッドを作成できませんでした。
ERROR_SERVICE_REQUEST_TIMEOUT	サービスのプロセスは開始されましたが、 StartServiceCtrlDispatcher を呼び出さなかったか、 StartServiceCtrlDispatcher を呼び出したスレッドがコントロールハンドラー関数内でブロックされている可能性があります。

解説(Remarks)

ドライバーサービスが開始されると、 StartService 関数はデバイスドライバーの初期化が完了するまで戻りません。

サービスが開始されると、サービスコントロールマネージャー (SCM) は必要に応じてサービスプロセスを生成します。指定されたサービスが他のサービスとプロセスを共有している場合、必要なプロセスが既に存在することがあります。 StartService 関数は、新しいサービスからの最初の状態更新を待ちません。これには時間がかかることがあるためです。代わりに、このサービスの ServiceMain スレッドが正常に作成されたという通知をサービスコントロールディスパッチャーから SCM が受け取った時点で戻ります。

SCM は StartService から戻る前に、次の既定の状態値を設定します。

サービスの現在の状態は SERVICE_START_PENDING に設定されます。
受け入れるコントロールは none (0) に設定されます。
CheckPoint 値は 0 に設定されます。
WaitHint 時間は 2 秒に設定されます。

呼び出し側プロセスは、 QueryServiceStatus 関数を定期的に呼び出してサービスの状態を照会することで、新しいサービスが初期化を完了したかどうかを判断できます。

サービスは初期化中に StartService を呼び出すことはできません。これは、SCM が初期化中にサービスコントロールデータベースをロックするため、 StartService の呼び出しがブロックされるためです。サービスが正常に開始したことを SCM に報告した後であれば、 StartService を呼び出すことができます。

ControlService と同様に、いずれかのサービスがコントロールコードの処理でビジー状態の場合、StartService は 30 秒間ブロックされます。タイムアウトが切れてもビジー状態のサービスがハンドラー関数から戻っていない場合、StartService は ERROR_SERVICE_REQUEST_TIMEOUT で失敗します。これは、SCM が一度に 1 つのサービスコントロール通知のみを処理するためです。

例

例については Starting a Service を参照してください。

メモ

winsvc.h ヘッダーは StartService を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不整合が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL StartServiceA(
    SC_HANDLE hService,
    DWORD dwNumServiceArgs,
    LPCSTR* lpServiceArgVectors   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool StartServiceA(
    IntPtr hService,   // SC_HANDLE
    uint dwNumServiceArgs,   // DWORD
    IntPtr lpServiceArgVectors   // LPCSTR* optional
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function StartServiceA(
    hService As IntPtr,   ' SC_HANDLE
    dwNumServiceArgs As UInteger,   ' DWORD
    lpServiceArgVectors As IntPtr   ' LPCSTR* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hService : SC_HANDLE
' dwNumServiceArgs : DWORD
' lpServiceArgVectors : LPCSTR* optional
Declare PtrSafe Function StartServiceA Lib "advapi32" ( _
    ByVal hService As LongPtr, _
    ByVal dwNumServiceArgs As Long, _
    ByVal lpServiceArgVectors As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

StartServiceA = ctypes.windll.advapi32.StartServiceA
StartServiceA.restype = wintypes.BOOL
StartServiceA.argtypes = [
    wintypes.HANDLE,  # hService : SC_HANDLE
    wintypes.DWORD,  # dwNumServiceArgs : DWORD
    ctypes.c_void_p,  # lpServiceArgVectors : LPCSTR* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
StartServiceA = Fiddle::Function.new(
  lib['StartServiceA'],
  [
    Fiddle::TYPE_VOIDP,  # hService : SC_HANDLE
    -Fiddle::TYPE_INT,  # dwNumServiceArgs : DWORD
    Fiddle::TYPE_VOIDP,  # lpServiceArgVectors : LPCSTR* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn StartServiceA(
        hService: *mut core::ffi::c_void,  // SC_HANDLE
        dwNumServiceArgs: u32,  // DWORD
        lpServiceArgVectors: *const *const u8  // LPCSTR* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool StartServiceA(IntPtr hService, uint dwNumServiceArgs, IntPtr lpServiceArgVectors);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_StartServiceA' -Namespace Win32 -PassThru
# $api::StartServiceA(hService, dwNumServiceArgs, lpServiceArgVectors)

#uselib "ADVAPI32.dll"
#func global StartServiceA "StartServiceA" sptr, sptr, sptr
; StartServiceA hService, dwNumServiceArgs, varptr(lpServiceArgVectors)   ; 戻り値は stat
; hService : SC_HANDLE -> "sptr"
; dwNumServiceArgs : DWORD -> "sptr"
; lpServiceArgVectors : LPCSTR* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global StartServiceA "StartServiceA" sptr, int, var
; res = StartServiceA(hService, dwNumServiceArgs, lpServiceArgVectors)
; hService : SC_HANDLE -> "sptr"
; dwNumServiceArgs : DWORD -> "int"
; lpServiceArgVectors : LPCSTR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global StartServiceA "StartServiceA" sptr, int, sptr
; res = StartServiceA(hService, dwNumServiceArgs, varptr(lpServiceArgVectors))
; hService : SC_HANDLE -> "sptr"
; dwNumServiceArgs : DWORD -> "int"
; lpServiceArgVectors : LPCSTR* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。