SAMPLE: MENUITEMTEMPLATE Structure Is Documented Incorrectly

• Microsoft Windows Software Development Kit (SDK) for Windows versions 3.0 and 3.1

SUMMARY

The MENUITEMTEMPLATE structure is found in WINDOWS.H, which declares the structure as follows:

   typedef struct
       {
       WORD    mtOption;
       WORD    mtID;
       char    mtString[1];
       } MENUITEMTEMPLATE;

MORE INFORMATION

MENUTEMP is a sample program in the Microsoft Software Library that demonstrates using the MENUITEMTEMPLATE structure and the LoadMenuIndirect() function.

Download MENUTEMP.EXE, a self-extracting file, from the Microsoft Software Library (MSL) on the following services:

• Microsoft Download Service (MSDL)

        Dial (206) 936-6735 to connect to MSDL
        Download MENUTEMP.EXE (size: 21078 bytes) 
  

• Internet (anonymous FTP)

        ftp ftp.microsoft.com
        Change to the \SOFTLIB\MSLFILES directory
        Get MENUTEMP.EXE (size: 21078 bytes) 
  

   MENUITEMTEMPLATE    mit;
   LPSTR               lpch;
   ...
   mit.mtString = lpch;
   ...

The mtString[1] declaration in the structure serves as a placeholder for an arbitrary number of characters. An application that uses the MENUITEMTEMPLATE structure must allocate memory both for the template itself and the string that is copied into mtString.

The following code sample demonstrates how an application might create a MENUITEMTEMPLATE structure for a checked menu item having an ID value of 100 and "&Menuitem" as its text:

   HANDLE              hMem;
   LPMENUITEMTEMPLATE  lpmit;
   static char         szMenuItem[] = "&Menuitem";

   ...

   // Note that the single char in the MENUITEMTEMPLATE structure
   // provides space for the null terminator on the string.
   hMem = LocalAlloc(LMEM_MOVEABLE, sizeof(MENUITEMTEMPLATE)
                                       + lstrlen(szMenuItem));

   // LocalLock function returns a near pointer;
   // no problem casting to a far pointer
   lpmit = (LPMENUITEMTEMPLATE)LocalLock(hMem);

   // Set the ID and the checked flag.
   lpmit->mtOption = MF_CHECKED;
   lpmit->mtID = 100;

   // Copy the menu item text.
   lstrcpy(lpmit->mtString, szMenuItem);

   ...

   // Make the following call, when a pointer is no longer needed.
   LocalUnlock(hMem);

   ...

   // Make the following call, when the MENUITEMTEMPLATE
   // is no longer needed.
   LocalFree(hMem);

   ...