# win32_start_service_ctrl_dispatcher

(PECL win32service >=0.1.0)

win32_start_service_ctrl_dispatcher — Enregistre un script avec SCM, alors il peut être interprété en tant que service avec le nom donné

### Description

win32_start_service_ctrl_dispatcher(string `$name`, bool `$gracefulMode` = true): void

Lorsque exécuté via le Gestionnaire de Contrôle de Service, un processus de service est requis pour "archiver" avec lui pour établir un service de surveillance et de communication ergonomique. Cette fonction effectue un archivage en démarrant un thread pour gérer les communications de bas niveau avec le gestionnaire de contrôle de service.

Une fois démarré, le processus du service doit faire 2 choses. La première est d'indiquer au Service Control Manager que le service est en cours d'exécution. La seconde est d'appeler la fonction win32_set_service_status() avec la constante `WIN32_SERVICE_RUNNING`. Si vous avez besoin de lancer des processus longs avant que le service ne soit lancé, alors vous pouvez utiliser la constante `WIN32_SERVICE_START_PENDING`. La seconde est de continuer à vérifier en utilisant le Service Control Manager sachant qu'il peut déterminer si le service se termine ou non. Ceci consiste à appeler, périodiquement, la fonction win32_get_last_control_message() et à traiter le code retourné.

Attention

Depuis la version 0.2.0, cette fonction fonctionne uniquement en ligne de commande. Elle est désactivé dans les autres cas.

### Liste de paramètres

`name`

  Le court nom du service, comme enregistré par win32_create_service().

`gracefulMode`

  `true` pour la sortie gracieuse. `false` pour la sortie avec erreur. Voir win32_set_service_exit_mode() pour plus de détails.

### Valeurs de retour

Aucune valeur n'est retournée.

Avant la version 1.0.0, retournait `WIN32_NO_ERROR` on success, `false` if there is a problem with the parameters or a Win32 Error Code on failure.

### Erreurs / Exceptions

Avant la version 1.0.0, si cette fonction est utilisé en dehors du SAPI `"cli"`, une erreur `E_ERROR` sera émise.

À partir de la version 1.0.0, lancera une Win32ServiceException si le SAPI n'est pas `"cli"`

### Historique

Version | Description
--- | ---
PECL win32service 1.0.0 | Lance une ValueError si un paramètre est invalide, avant `false` était retourné.
PECL win32service 1.0.0 | Lance une Win32ServiceException en cas d'erreur, avant un Code d'erreur Win32 était retourné.
PECL win32service 1.0.0 | Le type de retour est maintenant void, avant il était mixed.
PECL win32service 0.4.0 | Le paramètre `gracefulMode` a été ajouté.
PECL win32service 0.2.0 | Cette fonction fonctionne uniquement en ligne de commande.

### Exemples

Exemple #1 Exemple avec win32_start_service_ctrl_dispatcher()

Vérifie si le service fonctionne sous SCM.

`<?php
if (!win32_start_service_ctrl_dispatcher('dummyphp')) {
die("Je ne fonctionne probablement pas sous le gestionnaire de contrôle de service");
}
win32_set_service_status(WIN32_SERVICE_START_PENDING);
// Quelques processus longs à récupérer pendant que le service fonctionne.
win32_set_service_status(WIN32_SERVICE_RUNNING);
while (WIN32_SERVICE_CONTROL_STOP != win32_get_last_control_message()) {
# effectuer votre travail ici.
# essayez de ne pas prendre plus de 30 secondes avant de retourner au
}
?>`

### Voir aussi

- win32_set_service_status() - Met à jour le statut d'un service
- win32_get_last_control_message() - Retourne le dernier message de contrôle qui a été envoyé à ce service
- win32_set_service_exit_mode() - Définir ou renvoyer le mode de sortie pour le service en cours d'exécution
- win32_set_service_exit_code() - Définir ou renvoyer le code de sortie pour le service en cours d'exécution
- Les codes erreur Win32