BeginUpdateResourceA 関数 (winbase.h)

バイナリ モジュール内のリソースを追加、削除、または置換するために UpdateResource 関数で使用できるハンドルを取得します。

構文

HANDLE BeginUpdateResourceA(
  [in] LPCSTR pFileName,
  [in] BOOL   bDeleteExistingResources
);

パラメーター

[in] pFileName

型: LPCTSTR

リソースを更新するバイナリ ファイル。 アプリケーションは、このファイルへの書き込みアクセスを取得できる必要があります。 pFileName によって参照されているファイルを現在実行中にすることはできません。 pFileName で完全なパスが指定されていない場合、システムは現在のディレクトリ内のファイルを検索します。

[in] bDeleteExistingResources

種類: BOOL

pFileName パラメーターの既存のリソースを削除するかどうかを示します。 このパラメーターが TRUE の場合、既存のリソースが削除され、更新されたファイルには UpdateResource 関数で追加されたリソースのみが含まれます。 このパラメーターが FALSE の場合、 UpdateResource を使用して明示的に削除または置換されない限り、更新されたファイルには既存のリソースが含まれます。

戻り値

型: HANDLE

関数が成功した場合、戻り値は UpdateResource 関数と EndUpdateResource 関数で使用できるハンドルです。 指定したファイルが PE ではない場合、ファイルが存在しない場合、またはファイルを書き込み用に開くことができない場合、戻り値は NULL です 。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

この関数を呼び出す前に、リソース ファイルを読み込まないことをお勧めします。 ただし、そのファイルが既に読み込まれている場合、エラーは返されません。

Resource Configuration(RC Config) データを含むファイルのリソース更新には、LN ファイルと関連する .mui ファイルに関するいくつかの制限があります。 これらのファイルで更新できるリソースの種類の詳細については、 UpdateResource 関数の「解説」セクションを参照してください。

この関数は、コードとリソースの両方を含むモジュール内のリソースを更新できます。 前述のように、LN ファイルと .mui ファイルのリソース更新には制限があり、どちらも RC 構成データが含まれています。制限の詳細については、 UpdateResource 関数のリファレンスを参照してください。

例

例については、「 リソースの更新」を参照してください。

Note

winbase.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして BeginUpdateResource を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

サポートされている最小のクライアント	Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	winbase.h (Windows.h を含む)
Library	Kernel32.lib
[DLL]	Kernel32.dll

関連項目

概念

EndUpdateResource

リファレンス

リソース

UpdateResource