Функция InsertMenuW (winuser.h)

Статья
08/27/2023

Вставляет новый пункт меню в меню, перемещая другие элементы вниз по меню.

Примечание Функция InsertMenu заменена функцией InsertMenuItem . Однако вы по-прежнему можете использовать InsertMenu, если вам не нужны какие-либо расширенные функции InsertMenuItem.

Синтаксис

BOOL InsertMenuW(
  [in]           HMENU    hMenu,
  [in]           UINT     uPosition,
  [in]           UINT     uFlags,
  [in]           UINT_PTR uIDNewItem,
  [in, optional] LPCWSTR  lpNewItem
);

Параметры

[in] hMenu

Тип: HMENU

Дескриптор меню для изменения.

[in] uPosition

Тип: UINT

Элемент меню, перед которым должен быть вставлен новый пункт меню, как определено параметром uFlags .

[in] uFlags

Тип: UINT

Управляет интерпретацией параметра uPosition , а также содержимым, внешним видом и поведением нового пункта меню. Этот параметр должен содержать одно из следующих обязательных значений.

Значение	Значение
MF_BYCOMMAND 0x00000000L	Указывает, что параметр uPosition предоставляет идентификатор пункта меню. Флаг MF_BYCOMMAND используется по умолчанию, если не указан флаг MF_BYCOMMAND или MF_BYPOSITION .
MF_BYPOSITION 0x00000400L	Указывает, что параметр uPosition задает отсчитываемую от нуля относительную позицию нового пункта меню. Если значение uPosition равно -1, новый пункт меню добавляется в конец меню.

Параметр также должен содержать по крайней мере одно из следующих значений.

Значение	Значение
MF_BITMAP 0x00000004L	Использует точечный рисунок в качестве пункта меню. Параметр lpNewItem содержит дескриптор растрового изображения.
MF_CHECKED 0x00000008L	Помещает проверка метку рядом с пунктом меню. Если приложение предоставляет растровые изображения проверка метки (см. раздел SetMenuItemBitmaps), этот флаг отображает растровое изображение проверка метки рядом с элементом меню.
MF_DISABLED 0x00000002L	Отключает пункт меню, чтобы его нельзя было выбрать, но не серым.
MF_ENABLED 0x00000000L	Включает элемент меню, чтобы его можно было выбрать, и восстанавливает его из неактивного состояния.
MF_GRAYED 0x00000001L	Отключает элемент меню и выделяет его серым цветом, чтобы его нельзя было выбрать.
MF_MENUBARBREAK 0x00000020L	Работает так же, как и флаг MF_MENUBREAK для строки меню. Для раскрывающегося меню, подменю или контекстного меню новый столбец отделяется от старого столбца вертикальной линией.
MF_MENUBREAK 0x00000040L	Помещает элемент в новую строку (для строк меню) или в новый столбец (для раскрывающегося меню, подменю или контекстного меню) без разделения столбцов.
MF_OWNERDRAW 0x00000100L	Указывает, что элемент является элементом, нарисованным владельцем. Перед отображением меню в первый раз окно, которому принадлежит меню, получает WM_MEASUREITEM сообщение для получения ширины и высоты пункта меню. Сообщение WM_DRAWITEM затем отправляется в процедуру окна владельца всякий раз, когда необходимо обновить внешний вид пункта меню.
MF_POPUP 0x00000010L	Указывает, что пункт меню открывает раскрывающееся меню или подменю. Параметр uIDNewItem указывает дескриптор раскрывающегося меню или подменю. Этот флаг используется для добавления имени меню в строку меню или пункта меню, который открывает подменю в раскрывающемся меню, подменю или контекстном меню.
MF_SEPARATOR 0x00000800L	Рисует горизонтальную разделительную линию. Этот флаг используется только в раскрывающемся меню, подменю или контекстном меню. Линия не может быть серой, отключенной или выделенной. Параметры lpNewItem и uIDNewItem игнорируются.
MF_STRING 0x00000000L	Указывает, что элемент меню является текстовой строкой; Параметр lpNewItem является указателем на строку.
MF_UNCHECKED 0x00000000L	Не помещать проверка метку рядом с пунктом меню (по умолчанию). Если приложение предоставляет проверка пометки растровых изображений (см. функцию SetMenuItemBitmaps), этот флаг отображает чистое растровое изображение рядом с элементом меню.

[in] uIDNewItem

Тип: UINT_PTR

Идентификатор нового пункта меню или, если параметр uFlags имеет флаг MF_POPUP , дескриптор раскрывающегося меню или подменю.

[in, optional] lpNewItem

Тип: LPCTSTR

Содержимое нового пункта меню. Интерпретация lpNewItem зависит от того, включает ли параметр uFlags флаг MF_BITMAP, MF_OWNERDRAW или MF_STRING следующим образом.

Значение	Значение
MF_BITMAP 0x00000004L	Содержит дескриптор растрового рисунка.
MF_OWNERDRAW 0x00000100L	Содержит предоставленное приложением значение, которое можно использовать для хранения дополнительных данных, связанных с элементом меню. Значение находится в элементе itemData структуры, на которую указывает параметр lParamWM_MEASUREITEM или WM_DRAWITEM сообщения, отправленного при создании элемента меню или обновлении его внешнего вида.
MF_STRING 0x00000000L	Содержит указатель на строку, завершаемую null (значение по умолчанию).

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

Тип: BOOL

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

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

Требования


Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	winuser.h (включая Windows.h)
Библиотека	User32.lib
DLL	User32.dll
Набор API	ext-ms-win-ntuser-menu-l1-1-0 (появилось в Windows 8)