RmAddFilter 関数 (restartmanager.h)

  • [アーティクル]

アプリケーションまたはサービスに適用されるシャットダウンまたは再起動アクションを変更します。 プライマリ インストーラーは、 RmAddFilter 関数を複数回呼び出すことができます。 最新の呼び出しは、同じファイル、プロセス、またはサービスに対する以前の変更をオーバーライドします。

構文

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

パラメーター

[in] dwSessionHandle

既存の再起動マネージャー セッションへのハンドル。

[in, optional] strModuleName

アプリケーションの実行可能ファイルへの完全なパスを含む null で終わる文字列値へのポインター。 シャットダウンまたは再起動アクションの変更は、完全パスによって参照されるアプリケーションに適用されます。 Application または strServiceShortName パラメーターが NULL 以外の場合、このパラメーターは NULL である必要があります。

[in, optional] pProcess

アプリケーションの RM_UNIQUE_PROCESS 構造体へのポインター。 シャットダウンまたは再起動アクションの変更は、 RM_UNIQUE_PROCESS 構造体によって参照されるアプリケーションに適用されます。 strFilename パラメーターまたは strShortServiceName パラメーターが NULL 以外の場合、このパラメーターは NULL である必要があります。

[in, optional] strServiceShortName

短いサービス名を含む null で終わる文字列値へのポインター。 シャットダウンまたは再起動アクションの変更は、短いサービス ファイル名によって参照されるサービスに適用されます。 strFilename パラメーターまたは Application パラメーターが NULL 以外の場合、このパラメーターは NULL である必要があります。

[in] FilterAction

適用 する変更の 種類を指定するRM_FILTER_ACTION列挙値。

戻り値

これは、受信した最新のエラーです。 この関数は、Winerror.h で定義されている システム エラー コード のいずれかを返すことができます。

値 説明
ERROR_SUCCESS
0
 関数は正常に終了しました。
ERROR_BAD_ARGUMENTS
160
 1 つ以上の引数が正しくありません。 NULL ポインターまたは 0 が null 以外の値と 0 以外の値を必要とするパラメーターとして渡された場合、このエラー値は Restart Manager 関数によって返されます。
ERROR_SESSION_CREDENTIAL_CONFLICT
1219
 このエラーは、セカンダリ インストーラーがこの関数を呼び出すと返されます。 この関数は、プライマリ インストーラーでのみ使用できます。

要件

   
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー restartmanager.h
Library Rstrtmgr.lib
[DLL] Rstrtmgr.dll

関連項目

RmGetFilterList