Функция BeginUpdateResourceA (winbase.h)

Статья
11/20/2024

Извлекает дескриптор, который можно использовать функцией UpdateResource для добавления, удаления или замены ресурсов в двоичном модуле.

Синтаксис

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

Параметры

[in] pFileName

Тип: LPCTSTR

Двоичный файл, в котором необходимо обновить ресурсы. Приложение должно иметь возможность получить доступ на запись к этому файлу; Файл, на который ссылается pFileName не может выполняться в настоящее время. Если pFileName не указывает полный путь, система выполняет поиск файла в текущем каталоге.

[in] bDeleteExistingResources

Тип: BOOL

Указывает, следует ли удалить существующие ресурсы pFileName параметра. Если этот параметр TRUE, существующие ресурсы удаляются, а обновленный файл содержит только ресурсы, добавленные с помощью функции UpdateResource UpdateResource. Если этот параметр FALSE, обновленный файл включает существующие ресурсы, если они явно не удалены или заменены с помощью UpdateResource.

Возвращаемое значение

Тип: HANDLE

Если функция завершается успешно, возвращаемое значение — это дескриптор, который можно использовать UpdateResource и функции EndUpdateResource. Возвращаемое значение равно null если указанный файл не является pe, файл не существует или файл не может быть открыт для записи. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.

Замечания

Рекомендуется, чтобы файл ресурсов не загружался перед вызовом этой функции. Однако если этот файл уже загружен, он не приведет к возврату ошибки.

Существуют некоторые ограничения на обновления ресурсов в файлах, содержащих данные конфигурации ресурсов (RC Config): LN-файлы и связанные файлы MUI. Сведения о том, какие типы ресурсов разрешено обновлять в этих файлах, см. в разделе "Примечания" для функции UpdateResource.

Эта функция может обновлять ресурсы в модулях, содержащих как код, так и ресурсы. Как отмечалось выше, существуют ограничения на обновления ресурсов в файлах LN и MUI-файлах, которые содержат данные конфигурации RC; Подробные сведения об ограничениях приведены в справочнике для функции UpdateResource.

Примеры

Пример см. в обновлении ресурсов.

Заметка

Заголовок winbase.h определяет BeginUpdateResource как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winbase.h (включая Windows.h)
библиотеки	Kernel32.lib
DLL	Kernel32.dll