Função RmAddFilter (restartmanager.h)

Artigo
08/25/2023

Modifica as ações de desligamento ou reinicialização que são aplicadas a um aplicativo ou serviço. O instalador primário pode chamar a função RmAddFilter várias vezes. A chamada mais recente substitui todas as modificações anteriores no mesmo arquivo, processo ou serviço.

Sintaxe

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

Parâmetros

[in] dwSessionHandle

Um identificador para uma sessão existente do Gerenciador de Reinicialização.

[in, optional] strModuleName

Um ponteiro para um valor de cadeia de caracteres terminada em nulo que contém o caminho completo para o arquivo executável do aplicativo. As modificações nas ações de desligamento ou reinicialização são aplicadas ao aplicativo referenciado pelo caminho completo. Esse parâmetro deverá ser NULL se o parâmetro Application ou strServiceShortName não for NULL.

[in, optional] pProcess

Um ponteiro para uma estrutura RM_UNIQUE_PROCESS para o aplicativo. Modificações nas ações de desligamento ou reinicialização são aplicadas ao aplicativo referenciado pela estrutura RM_UNIQUE_PROCESS . Esse parâmetro deverá ser NULL se o parâmetro strFilename ou strShortServiceName não for NULL.

[in, optional] strServiceShortName

Um ponteiro para um valor de cadeia de caracteres terminada em nulo que contém o nome do serviço curto. As modificações nas ações de desligamento ou reinicialização são aplicadas ao serviço referenciado pelo nome de arquivo de serviço curto. Esse parâmetro deverá ser NULL se o parâmetro strFilename ou Application não for NULL.

[in] FilterAction

Um RM_FILTER_ACTION valor de enumeração que especifica o tipo de modificação a ser aplicado.

Valor retornado

Esse é o erro mais recente recebido. A função pode retornar um dos códigos de erro do sistema definidos em Winerror.h.

Valor	Significado
ERROR_SUCCESS 0	A função foi concluída com êxito.
ERROR_BAD_ARGUMENTS 160	Um ou mais argumentos não estão corretos. Esse valor de erro será retornado pela função Gerenciador de Reinicialização se um ponteiro NULL ou 0 for passado como um parâmetro que requer um valor não nulo e diferente de zero.
ERROR_SESSION_CREDENTIAL_CONFLICT 1219	Esse erro é retornado quando um instalador secundário chama essa função. Essa função só está disponível para instaladores primários.

Requisitos


Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	restartmanager.h
Biblioteca	Rstrtmgr.lib
DLL	Rstrtmgr.dll

Confira também

RmGetFilterList

Compartilhar via