Method DestroyHandle

source/script_menu.cpp:1090–1117

void UserMenu::DestroyHandle()
// Destroys the Win32 menu or marks it NULL if it has already been destroyed externally.
// This should be called only when the UserMenu is being deleted (or the script is exiting),
// otherwise any parent menus would still refer to the old Win32 menu.  If the UserMenu is
// being deleted, that implies that its reference count is zero, meaning it isn't in use as
// a submenu or menu bar.
{
	if (!mMenu)  // For performance.
		return;
	// Testing on Windows 10 shows that DestroyMenu() is able to destroy a menu even while it is
	// being displayed, causing only temporary cosmetic issues.  Previous testing with menu bars
	// showed similar results.  There wouldn't be much point in checking the following because the
	// script is in an uninterruptible state while the menu is displayed, which in addition to
	// pausing the current thread (which happens anyway), no new threads can be launched:
	//if (g_MenuIsVisible)
	//	return FAIL;

	// MSDN: "DestroyMenu is recursive, that is, it will destroy the menu and all its submenus."
	// Therefore remove all submenus before destroying the menu, in case the script is using them.
	// If the script is not using them, they will be destroyed automatically as they are released
	// by ~UserMenuItem().
	for (UserMenuItem *mi = mFirstMenuItem; mi ; mi = mi->mNextMenuItem)
		if (mi->mSubmenu)
			RemoveMenu(mMenu, mi->mMenuID, MF_BYCOMMAND);

	DestroyMenu(mMenu);
	mMenu = NULL;
}