[NETSH] Fix help output

- Increase the output buffer for context and group help texts.
- Use a heap buffers to load and format the command help texts.
- Pass the full command name to FormatMessage to make help output work with WinXP helpers.
- Adjust the internal help texts accordingly.

Author: EricKohl

base/applications/network/netsh/help.c

@@ -12,6 +12,10 @@
 #define NDEBUG
 #include <debug.h>
 
+#define HUGE_HELP_BUFFER_SIZE  2048
+#define SMALL_HELP_BUFFER_SIZE  160
+#define TINY_HELP_BUFFER_SIZE    80
+
 typedef enum
 {
     Command,
@@ -60,15 +64,15 @@ VOID
 PrintCurrentContextHeader(
     _In_ PCONTEXT_ENTRY pContext)
 {
-    WCHAR szBuffer[80];
+    WCHAR szBuffer[SMALL_HELP_BUFFER_SIZE];
 
     if (pContext == pCurrentContext)
     {
         ConResPrintf(StdOut, IDS_THIS_COMMANDS);
     }
     else
     {
-        GetContextFullName(pContext, szBuffer, 80);
+        GetContextFullName(pContext, szBuffer, SMALL_HELP_BUFFER_SIZE);
         ConResPrintf(StdOut, IDS_CONTEXT_COMMANDS, szBuffer);
     }
 }
@@ -81,14 +85,14 @@ PrintShortGroupCommands(
     _In_ PCOMMAND_GROUP pGroup)
 {
     PCOMMAND_ENTRY pCommand;
-    WCHAR szBuffer1[64];
-    WCHAR szBuffer2[80];
+    WCHAR szBuffer1[TINY_HELP_BUFFER_SIZE];
+    WCHAR szBuffer2[SMALL_HELP_BUFFER_SIZE];
 
     pCommand = pGroup->pCommandListHead;
     while (pCommand != NULL)
     {
         swprintf(szBuffer1, L"%s %s", pGroup->pwszCmdGroupToken, pCommand->pwszCmdToken);
-        LoadStringW(pContext->hModule, pCommand->dwShortCmdHelpToken, szBuffer2, 80);
+        LoadStringW(pContext->hModule, pCommand->dwShortCmdHelpToken, szBuffer2, SMALL_HELP_BUFFER_SIZE);
 
         ConPrintf(StdOut, L"%-15s - %s", szBuffer1, szBuffer2);
         pCommand = pCommand->pNext;
@@ -116,7 +120,7 @@ PrintContext(
     PCONTEXT_ENTRY pSubContext;
     PHELP_ENTRY pHelpArray = NULL;
     DWORD dwCount = 0, dwIndex;
-    WCHAR szBuffer[80];
+    WCHAR szBuffer[SMALL_HELP_BUFFER_SIZE];
 
     DPRINT("PrintContext()\n");
 
@@ -198,13 +202,13 @@ PrintContext(
         {
             case Command:
             case Group:
-                if (LoadStringW(pContext->hModule, pHelpArray[dwIndex].dwHelpId, szBuffer, 80) == 0)
+                if (LoadStringW(pContext->hModule, pHelpArray[dwIndex].dwHelpId, szBuffer, SMALL_HELP_BUFFER_SIZE) == 0)
                     szBuffer[0] = UNICODE_NULL;
                 ConPrintf(StdOut, L"%-15s - %s", pHelpArray[dwIndex].pszCommand, szBuffer);
                 break;
 
             case SubContext:
-                GetContextFullName(pHelpArray[dwIndex].Pointer.pSubContext, szBuffer, 80);
+                GetContextFullName(pHelpArray[dwIndex].Pointer.pSubContext, szBuffer, SMALL_HELP_BUFFER_SIZE);
                 ConPrintf(StdOut, L"%-15s - Changes to the \"%s\" context.\n", pHelpArray[dwIndex].pszCommand, szBuffer);
                 break;
         }
@@ -273,12 +277,58 @@ PrintSubcontexts(
 VOID
 PrintCommandHelp(
     _In_ PCONTEXT_ENTRY pContext,
+    _In_ PCOMMAND_GROUP pGroup,
     _In_ PCOMMAND_ENTRY pCommand)
 {
-    WCHAR szBuffer[80];
+    LPWSTR pszInBuffer = NULL, pszOutBuffer = NULL, pszCommandBuffer = NULL;
+    DWORD_PTR Args[2];
+
+    DPRINT("PrintCommandHelp(%p %p %p)\n", pContext, pGroup, pCommand);
+
+    pszInBuffer = HeapAlloc(GetProcessHeap(), 0, HUGE_HELP_BUFFER_SIZE * sizeof(WCHAR));
+    if (pszInBuffer == NULL)
+        goto done;
+
+    pszOutBuffer = HeapAlloc(GetProcessHeap(), 0, HUGE_HELP_BUFFER_SIZE * sizeof(WCHAR));
+    if (pszOutBuffer == NULL)
+        goto done;
+
+    pszCommandBuffer = HeapAlloc(GetProcessHeap(), 0, TINY_HELP_BUFFER_SIZE * sizeof(WCHAR));
+    if (pszCommandBuffer == NULL)
+        goto done;
+
+    wcscpy(pszCommandBuffer, pCommand->pwszCmdToken);
+    if (pGroup)
+    {
+        wcscat(pszCommandBuffer, L" ");
+        wcscat(pszCommandBuffer, pGroup->pwszCmdGroupToken);
+    }
+
+    LoadStringW(pContext->hModule, pCommand->dwCmdHlpToken, pszInBuffer, HUGE_HELP_BUFFER_SIZE);
+
+    Args[0] = (DWORD_PTR)pszCommandBuffer;
+    Args[1] = (DWORD_PTR)NULL;
+
+    FormatMessageW(FORMAT_MESSAGE_FROM_STRING | FORMAT_MESSAGE_ARGUMENT_ARRAY,
+                   pszInBuffer,
+                   0,
+                   0,
+                   pszOutBuffer,
+                   HUGE_HELP_BUFFER_SIZE,
+                   (va_list *)&Args);
+
+    ConPuts(StdOut, pszOutBuffer);
+    ConPuts(StdOut, L"\n");
+
+done:
+    if (pszCommandBuffer)
+        HeapFree(GetProcessHeap(), 0, pszCommandBuffer);
+
+    if (pszOutBuffer)
+        HeapFree(GetProcessHeap(), 0, pszOutBuffer);
 
-    LoadStringW(pContext->hModule, pCommand->dwCmdHlpToken, szBuffer, 80);
-    ConPrintf(StdOut, szBuffer);
+    if (pszInBuffer)
+        HeapFree(GetProcessHeap(), 0, pszInBuffer);
 }
 
 

base/applications/network/netsh/interpreter.c

@@ -136,8 +136,8 @@ InterpretCommand(
     _Inout_ PBOOL bDone)
 {
     PCONTEXT_ENTRY pTempContext, pTempSubContext = NULL;
-    PCOMMAND_GROUP pGroup;
-    PCOMMAND_ENTRY pCommand;
+    PCOMMAND_GROUP pGroup = NULL;
+    PCOMMAND_ENTRY pCommand = NULL;
     INTERPRETER_STATE State = STATE_ANALYZE;
     DWORD dwArgIndex = 0;
     DWORD dwError = ERROR_SUCCESS;
@@ -197,7 +197,7 @@ InterpretCommand(
                 if (((dwArgIndex + 1) == (dwArgCount - 1)) &&
                     ((_wcsicmp(argv[dwArgIndex + 1], L"?") == 0) || (_wcsicmp(argv[dwArgIndex + 1], L"help") == 0)))
                 {
-                    PrintCommandHelp(pTempContext, pCommand);
+                    PrintCommandHelp(pTempContext, pGroup, pCommand);
                     State = STATE_DONE;
                     break;
                 }
@@ -209,9 +209,9 @@ InterpretCommand(
                     if (dwError != ERROR_SUCCESS)
                     {
                         if (dwError == ERROR_SHOW_USAGE)
-                            PrintCommandHelp(pTempContext, pCommand);
+                            PrintCommandHelp(pTempContext, pGroup, pCommand);
                         else
-                            ConPrintf(StdOut, L"Commnand: %S  Error: %lu\n\n", pCommand->pwszCmdToken, dwError);
+                            ConPrintf(StdOut, L"Command: %s  Error: %lu\n\n", pCommand->pwszCmdToken, dwError);
                     }
                 }
 

base/applications/network/netsh/lang/en-US.rc

@@ -26,29 +26,29 @@ BEGIN
     IDS_SUBCONTEXT_HEADER "\nThe following sub-contexts are available:\n"
 
     IDS_HLP_UP             "Goes up one context level.\n"
-    IDS_HLP_UP_EX          "Syntax: ..\n\n        Goes up one context level.\n\n"
+    IDS_HLP_UP_EX          "Usage: %1!s!\n\n        Goes up one context level.\n"
     IDS_HLP_EXIT           "Exits the program.\n"
-    IDS_HLP_EXIT_EX        "Syntax: exit\n\n        Exits the program.\n\n"
+    IDS_HLP_EXIT_EX        "Usage: %1!s!\n\n        Exits the program.\n"
     IDS_HLP_HELP           "Displays a list of commands.\n"
-    IDS_HLP_HELP_EX        "Syntax: help\n\n        Displays a list of commands.\n\n"
+    IDS_HLP_HELP_EX        "Usage: %1!s!\n\n        Displays a list of commands.\n"
     IDS_HLP_POPD           "Changes to the context on the stack.\n"
-    IDS_HLP_POPD_EX        "Syntax: popd\n\n        Changes to the context on the stack.\n\n"
+    IDS_HLP_POPD_EX        "Usage: %1!s!\n\n        Changes to the context on the stack.\n"
     IDS_HLP_PUSHD          "Stores the current context on the stack.\n"
-    IDS_HLP_PUSHD_EX       "Syntax: pushd\n\n        Stores the current context on the stack.\n\n"
+    IDS_HLP_PUSHD_EX       "Usage: %1!s!\n\n        Stores the current context on the stack.\n"
     IDS_HLP_EXEC           "Runs a script file.\n"
-    IDS_HLP_EXEC_EX        "Syntax: exec <ScriptFile>\n\n        Loads the script file and runs it.\n\n"
+    IDS_HLP_EXEC_EX        "Usage: %1!s! <script file name>\n\n        Loads the script file and runs it.\n"
     IDS_HLP_DUMP           "Displays a configuration script.\n"
-    IDS_HLP_DUMP_EX        "Syntax: dump\n\n        Creates a script that contains the current configuration. If saved to a\n\
-        file, the script can be used to altered configuration settings.\n\n"
+    IDS_HLP_DUMP_EX        "Syntax: %1!s!\n\n        Creates a script that contains the current configuration. If saved to a\n\
+        file, the script can be used to altered configuration settings.\n"
 
     IDS_HLP_ADD_HELPER     "Installs a helper DLL.\n"
-    IDS_HLP_ADD_HELPER_EX  "Syntax: add helper <dll file name>\n\n        Installs the specified helper DLL in netsh.\n\n"
+    IDS_HLP_ADD_HELPER_EX  "Usage: %1!s! <dll file name>\n\n        Installs the specified helper DLL in netsh.\n"
 
     IDS_HLP_DEL_HELPER     "Removes a helper DLL.\n"
-    IDS_HLP_DEL_HELPER_EX  "Syntax: delete helper <dll file name>\n\n        Removes the specified helper DLL from netsh.\n\n"
+    IDS_HLP_DEL_HELPER_EX  "Usage: %1!s! <dll file name>\n\n        Removes the specified helper DLL from netsh.\n"
 
     IDS_HLP_SHOW_HELPER    "Lists all the top-level helpers.\n"
-    IDS_HLP_SHOW_HELPER_EX "Syntax: show helper\n\n        Lists all the top-level helpers.\n\n"
+    IDS_HLP_SHOW_HELPER_EX "Usage: %1!s!\n\n        Lists all the top-level helpers.\n"
 
     IDS_HLP_GROUP_ADD      "Adds a configuration entry to a list of entries.\n"
     IDS_HLP_GROUP_DELETE   "Deletes a configuration entry from a list of entries.\n"

base/applications/network/netsh/precomp.h

@@ -150,6 +150,7 @@ FindContextByGuid(
 VOID
 PrintCommandHelp(
     _In_ PCONTEXT_ENTRY pContext,
+    _In_ PCOMMAND_GROUP pGroup,
     _In_ PCOMMAND_ENTRY pCommand);
 
 VOID