Fonction RmAddFilter (restartmanager.h)

Article
08/25/2023

Modifie les actions d’arrêt ou de redémarrage appliquées à une application ou à un service. Le programme d’installation principal peut appeler la fonction RmAddFilter plusieurs fois. L’appel le plus récent remplace toutes les modifications précédentes apportées au même fichier, processus ou service.

Syntaxe

DWORD RmAddFilter(
  [in]           DWORD             dwSessionHandle,
  [in, optional] LPCWSTR           strModuleName,
  [in, optional] RM_UNIQUE_PROCESS *pProcess,
  [in, optional] LPCWSTR           strServiceShortName,
  [in]           RM_FILTER_ACTION  FilterAction
);

Paramètres

[in] dwSessionHandle

Handle pour une session du Gestionnaire de redémarrage existante.

[in, optional] strModuleName

Pointeur vers une valeur de chaîne terminée par null qui contient le chemin d’accès complet au fichier exécutable de l’application. Les modifications apportées aux actions d’arrêt ou de redémarrage sont appliquées à l’application référencée par le chemin d’accès complet. Ce paramètre doit être NULL si le paramètre Application ou strServiceShortName n’est pas NULL.

[in, optional] pProcess

Pointeur vers une structure RM_UNIQUE_PROCESS pour l’application. Les modifications apportées aux actions d’arrêt ou de redémarrage sont appliquées à l’application référencée par la structure RM_UNIQUE_PROCESS . Ce paramètre doit être NULL si le paramètre strFilename ou strShortServiceName n’est pas NULL.

[in, optional] strServiceShortName

Pointeur vers une valeur de chaîne terminée par null qui contient le nom de service court. Les modifications apportées aux actions d’arrêt ou de redémarrage sont appliquées au service référencé par un nom de fichier de service court. Ce paramètre doit avoir la valeur NULL si le paramètre strFilename ou Application n’est pas NULL.

[in] FilterAction

Valeur d’énumération RM_FILTER_ACTION qui spécifie le type de modification à appliquer.

Valeur retournée

Il s’agit de l’erreur la plus récente reçue. La fonction peut retourner l’un des codes d’erreur système définis dans Winerror.h.

Valeur	Signification
ERROR_SUCCESS 0	La fonction s’est terminée avec succès.
ERROR_BAD_ARGUMENTS 160	Un ou plusieurs arguments sont incorrects. Cette valeur d’erreur est retournée par la fonction Restart Manager si un pointeur NULL ou 0 est passé en tant que paramètre qui nécessite une valeur non null et une valeur non nulle.
ERROR_SESSION_CREDENTIAL_CONFLICT 1219	Cette erreur est retournée lorsqu’un programme d’installation secondaire appelle cette fonction. Cette fonction est uniquement disponible pour les programmes d’installation principaux.

Spécifications


Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	restartmanager.h
Bibliothèque	Rstrtmgr.lib
DLL	Rstrtmgr.dll

Voir aussi

RmGetFilterList

Partager via