help.c File Reference

#include "precomp.h"
#include <debug.h>

Include dependency graph for help.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
static VOID	GetContextFullName (_In_ PCONTEXT_ENTRY pContext, _Inout_ LPWSTR pszBuffer, _In_ DWORD cchLength)
static VOID	HelpContext (PCONTEXT_ENTRY pContext)
VOID	HelpGroup (PCOMMAND_GROUP pGroup)
DWORD WINAPI	HelpCommand (LPCWSTR pwszMachine, LPWSTR *ppwcArguments, DWORD dwCurrentIndex, DWORD dwArgCount, DWORD dwFlags, LPCVOID pvData, BOOL *pbDone)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 12 of file help.c.

Function Documentation

GetContextFullName()

static VOID GetContextFullName ( _In_ PCONTEXT_ENTRY  pContext, _Inout_ LPWSTR  pszBuffer, _In_ DWORD  cchLength  )

static

Definition at line 19 of file help.c.

{
    if (pContext->pParentContext != NULL)
    {
        GetContextFullName(pContext->pParentContext, pszBuffer, cchLength);
        wcscat(pszBuffer, L" ");
        wcscat(pszBuffer, pContext->pszContextName);
    }
    else
    {
        wcscpy(pszBuffer, L"netsh");
    }
}

Referenced by GetContextFullName(), and HelpContext().

HelpCommand()

DWORD WINAPI HelpCommand	(	LPCWSTR	pwszMachine,
		LPWSTR *	ppwcArguments,
		DWORD	dwCurrentIndex,
		DWORD	dwArgCount,
		DWORD	dwFlags,
		LPCVOID	pvData,
		BOOL *	pbDone
	)

Definition at line 116 of file help.c.

{
    PCONTEXT_ENTRY pContext;
 
    ConResPrintf(StdOut, IDS_HELP_HEADER);
 
    pContext = pCurrentContext;
    if (pContext == NULL)
    {
        DPRINT1("HelpCommand: invalid context %p\n", pContext);
        return 1;
    }
 
    HelpContext(pContext);
 
    if (pCurrentContext->pSubContextHead != NULL)
    {
        ConResPrintf(StdOut, IDS_SUBCONTEXT_HEADER);
        pContext = pCurrentContext->pSubContextHead;
        while (pContext != NULL)
        {
            ConPrintf(StdOut, L" %s", pContext->pszContextName);
            pContext = pContext->pNext;
        }
        ConPuts(StdOut, L"\n");
    }
    ConPuts(StdOut, L"\n");
 
    return ERROR_SUCCESS;
}

Referenced by CreateRootContext(), help_main(), InterpretCmd(), and main().

HelpContext()

static VOID HelpContext ( PCONTEXT_ENTRY  pContext )

static

Definition at line 39 of file help.c.

{
    PCONTEXT_ENTRY pSubContext;
    PCOMMAND_ENTRY pCommand;
    PCOMMAND_GROUP pGroup;
    WCHAR szBuffer[80];
 
    if (pContext != pRootContext)
        HelpContext(pContext->pParentContext);
 
    if (pContext == pCurrentContext)
    {
        ConPrintf(StdOut, L"\nCommands in this context:\n");
    }
    else if (pContext == pRootContext)
    {
        ConPrintf(StdOut, L"\nCommands in the netsh-context:\n");
    }
    else
    {
        GetContextFullName(pContext, szBuffer, 80);
        ConPrintf(StdOut, L"\nCommands in the %s-context:\n", szBuffer);
    }
 
    pCommand = pContext->pCommandListHead;
    while (pCommand != NULL)
    {
        if (LoadStringW(pContext->hModule, pCommand->dwShortCmdHelpToken, szBuffer, 80) == 0)
            szBuffer[0] = UNICODE_NULL;
        ConPrintf(StdOut, L"%-15s - %s\n", pCommand->pwszCmdToken, szBuffer);
        pCommand = pCommand->pNext;
    }
 
    pGroup = pContext->pGroupListHead;
    while (pGroup != NULL)
    {
        if (LoadStringW(pContext->hModule, pGroup->dwShortCmdHelpToken, szBuffer, 80) == 0)
            szBuffer[0] = UNICODE_NULL;
        ConPrintf(StdOut, L"%-15s - %s\n", pGroup->pwszCmdGroupToken, szBuffer);
        pGroup = pGroup->pNext;
    }
 
    pSubContext = pContext->pSubContextHead;
    while (pSubContext != NULL)
    {
        GetContextFullName(pSubContext, szBuffer, 80);
        ConPrintf(StdOut, L"%-15s - Changes to the \"%s\" context.\n", pSubContext->pszContextName, szBuffer);
        pSubContext = pSubContext->pNext;
    }
}

Referenced by HelpCommand(), HelpContext(), MSFT_DoFuncs(), and MSFT_DoVars().

HelpGroup()

VOID HelpGroup

(

PCOMMAND_GROUP

pGroup

)

Definition at line 93 of file help.c.

{
    PCOMMAND_ENTRY pCommand;
    WCHAR szBuffer[64];
 
    ConResPrintf(StdOut, IDS_HELP_HEADER);
 
    ConPrintf(StdOut, L"\nCommands in this context:\n");
 
    pCommand = pGroup->pCommandListHead;
    while (pCommand != NULL)
    {
        swprintf(szBuffer, L"%s %s", pGroup->pwszCmdGroupToken, pCommand->pwszCmdToken);
        ConPrintf(StdOut, L"%-15s - ", szBuffer);
        ConResPuts(StdOut, pCommand->dwShortCmdHelpToken);
        pCommand = pCommand->pNext;
    }
}

Referenced by InterpretCommand().