RmRemoveFilter function

Removes any modifications to shutdown or restart actions that have been applied using the RmAddFilter function. The primary installer can call the RmRemoveFilter function multiple times.

Syntax


DWORD WINAPI RmRemoveFilter(
  _In_     DWORD             dwSessionHandle,
  _In_opt_ LPCWSTR           strFilename,
  _In_opt_ RM_UNIQUE_PROCESS *Application,
  _In_opt_ LPCWSTR           strShortServiceName
);

Parameters

dwSessionHandle [in]

A handle to an existing Restart Manager session.

strFilename [in, optional]

A pointer to a null-terminated string value that contains the full path for the application's executable file. The RmRemoveFilter function removes any modifications to the referenced application's shutdown or restart actions previously applied by the RmAddFilter function. This parameter must be NULL if the Application or strServiceShortName parameter is non-NULL.

Application [in, optional]

The RM_UNIQUE_PROCESS structure for the application. The RmRemoveFilter function removes any modifications to the referenced application's shutdown or restart actions previously applied by the RmAddFilter function. This parameter must be NULL if the strFilename or strShortServiceName parameter is non-NULL.

strShortServiceName [in, optional]

A pointer to a null-terminated string value that contains the short service name. The RmRemoveFilter function removes any modifications to the referenced service's shutdown or restart actions previously applied by the RmAddFilter function. This parameter must be NULL if the strFilename or Application parameter is non-NULL.

Return value

This is the most recent error received. The function can return one of the system error codes that are defined in Winerror.h.

ValueMeaning
ERROR_SUCCESS
0

The function completed successfully.

ERROR_FILE_NOT_FOUND
1

The specified filter could not be found.

ERROR_SESSION_CREDENTIAL_CONFLICT
1219

This error is returned when a secondary installer calls this function. This function is only available to primary installers.

 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

RestartManager.h

Library

Rstrtmgr.lib

DLL

Rstrtmgr.dll

 

 

Community Additions

ADD
Show: