Windows Help PositionWindow Macro Documented Incorrectly

• Microsoft Windows Software Development Kit (SDK) version 3.1
• Microsoft Win32 SDK, versions 3.5 and 3.51

SUMMARY

In source files for Windows Help, the help author can specify the size, position, and state of a window with the PositionWindow macro.

MORE INFORMATION

According to page 326 of the "Microsoft Windows Software Development Kit: Programmer's Reference, Volume 4: Resources," the state parameter to the PositionWindow macro is either 0 to specify a normal sized window or 1 to specify a maximized window. This information is incorrect. The state parameter can assume any of ten different values, as follows:

           Corresponding
   Value  Windows Constant    Action
   -----  ----------------    ------

     0    SW_HIDE             Hides the window and passes activation to
                              another window.

     1    SW_SHOWNORMAL       Activates and displays a window. If the
                              window is minimized or maximized, Windows
                              restores it to its original size and
                              position.

     2    SW_SHOWMINIMIZED    Activates the window and displays it as an
                              icon.

     3    SW_SHOWMAXIMIZED    Activates the window and displays it as a
                              maximized window.

     4    SW_SHOWNOACTIVATE   Displays a window in its most recent size
                              and position. The window that is currently
                              active remains active.

     5    SW_SHOW             Activates a window and displays it in its
                              current size and position.

     6    SW_MINIMIZE         Minimizes the specified window and
                              activates the top-level window in the
                              window-manager's list.

     7    SW_SHOWMINNOACTIVE  Displays the window as iconic. The window
                              that is currently active remains active.

     8    SW_SHOW             Displays the window in its current state.
                              The window that is currently active remains
                              active.

     9    SW_RESTORE          Same as SW_SHOWNORMAL.