Edit

Share via

RmGetFilterList function (restartmanager.h)

  • Article

Lists the modifications to shutdown and restart actions that have already been applied by the RmAddFilter function. The function returns a pointer to a buffer containing information about the modifications which have been applied.

Syntax

DWORD RmGetFilterList(
  [in]            DWORD   dwSessionHandle,
  [out, optional] PBYTE   pbFilterBuf,
  [in]            DWORD   cbFilterBuf,
  [out]           LPDWORD cbFilterBufNeeded
);

Parameters

[in] dwSessionHandle

A handle to an existing Restart Manager session.

[out, optional] pbFilterBuf

A pointer to a buffer that contains modification information.

[in] cbFilterBuf

The size of the buffer that contains modification information in bytes.

[out] cbFilterBufNeeded

The number of bytes needed in the buffer.

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.

Value Meaning
ERROR_SUCCESS
0
 The function completed successfully.
ERROR_BAD_ARGUMENTS
160
 One or more arguments are not correct. This error value is returned by the Restart Manager function if a NULL pointer or 0 is passed in as a parameter that requires a non-null and non-zero value.
ERROR_MORE_DATA
234
 This error value is returned by the RmGetFilterList function if the pbFilterBuf buffer is too small to hold all the application information in the list or if cbFilterBufNeeded was not specified.
ERROR_SESSION_CREDENTIAL_CONFLICT
1219
 This error is returned when a secondary installer calls this function. This function is only available to primary installers.

Remarks

The returned pbFilterBuf buffer has to be typecast to RM_FILTER_INFO to access the filter list.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header restartmanager.h
Library Rstrtmgr.lib
DLL Rstrtmgr.dll

See also

RmAddFilter