netsh.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_CMD_ENTRY
struct	_CMD_GROUP_ENTRY
struct	_NS_HELPER_ATTRIBUTES
struct	_NS_CONTEXT_ATTRIBUTES
struct	_TAG_TYPE
struct	_TOKEN_VALUE

Macros
#define	NETSH_ERROR_BASE   15000
#define	ERROR_NO_ENTRIES   (NETSH_ERROR_BASE + 0)
#define	ERROR_INVALID_SYNTAX   (NETSH_ERROR_BASE + 1)
#define	ERROR_PROTOCOL_NOT_IN_TRANSPORT   (NETSH_ERROR_BASE + 2)
#define	ERROR_NO_CHANGE   (NETSH_ERROR_BASE + 3)
#define	ERROR_CMD_NOT_FOUND   (NETSH_ERROR_BASE + 4)
#define	ERROR_ENTRY_PT_NOT_FOUND   (NETSH_ERROR_BASE + 5)
#define	ERROR_DLL_LOAD_FAILED   (NETSH_ERROR_BASE + 6)
#define	ERROR_INIT_DISPLAY   (NETSH_ERROR_BASE + 7)
#define	ERROR_TAG_ALREADY_PRESENT   (NETSH_ERROR_BASE + 8)
#define	ERROR_INVALID_OPTION_TAG   (NETSH_ERROR_BASE + 9)
#define	ERROR_NO_TAG   (NETSH_ERROR_BASE + 10)
#define	ERROR_MISSING_OPTION   (NETSH_ERROR_BASE + 11)
#define	ERROR_TRANSPORT_NOT_PRESENT   (NETSH_ERROR_BASE + 12)
#define	ERROR_SHOW_USAGE   (NETSH_ERROR_BASE + 13)
#define	ERROR_INVALID_OPTION_VALUE   (NETSH_ERROR_BASE + 14)
#define	ERROR_OKAY   (NETSH_ERROR_BASE + 15)
#define	ERROR_CONTINUE_IN_PARENT_CONTEXT   (NETSH_ERROR_BASE + 16)
#define	ERROR_SUPPRESS_OUTPUT   (NETSH_ERROR_BASE + 17)
#define	ERROR_HELPER_ALREADY_REGISTERED   (NETSH_ERROR_BASE + 18)
#define	ERROR_CONTEXT_ALREADY_REGISTERED   (NETSH_ERROR_BASE + 19)
#define	ERROR_PARSING_FAILURE   (NETSH_ERROR_BASE + 20)
#define	NETSH_ERROR_END   ERROR_CONTEXT_ALREADY_REGISTERED
#define	DEFAULT_CONTEXT_PRIORITY   100
#define	NETSH_ROOT_GUID   {0, 0, 0, {0, 0, 0, 0, 0, 0, 0, 0}}

Typedefs
typedef enum _NS_REQS	NS_REQS
typedef DWORD(WINAPI *	PGET_RESOURCE_STRING_FN) (_In_ DWORD dwMsgID, _Out_ LPWSTR lpBuffer, _In_ DWORD nBufferMax)
typedef DWORD(WINAPI *	PNS_DLL_INIT_FN) (_In_ DWORD dwNetshVersion, _Out_ PVOID pReserved)
typedef DWORD(WINAPI *	PNS_HELPER_START_FN) (_In_ const GUID *pguidParent, _In_ DWORD dwVersion)
typedef DWORD(WINAPI *	PNS_HELPER_STOP_FN) (_In_ DWORD dwReserved)
typedef DWORD(WINAPI *	PNS_CONTEXT_COMMIT_FN) (_In_ DWORD dwAction)
typedef DWORD(WINAPI *	PNS_CONTEXT_CONNECT_FN) (_In_ LPCWSTR pwszMachine)
typedef DWORD(WINAPI *	PNS_CONTEXT_DUMP_FN) (_In_ LPCWSTR pwszRouter, _In_ LPWSTR *ppwcArguments, _In_ DWORD dwArgCount, _In_ LPCVOID pvData)
typedef BOOL(WINAPI *	PNS_OSVERSIONCHECK) (_In_ UINT CIMOSType, _In_ UINT CIMOSProductSuite, _In_ LPCWSTR CIMOSVersion, _In_ LPCWSTR CIMOSBuildNumber, _In_ LPCWSTR CIMServicePackMajorVersion, _In_ LPCWSTR CIMServicePackMinorVersion, _In_ UINT uiReserved, _In_ DWORD dwReserved)
typedef DWORD(WINAPI *	PFN_HANDLE_CMD) (_In_ LPCWSTR pwszMachine, _In_ LPWSTR *ppwcArguments, _In_ DWORD dwCurrentIndex, _In_ DWORD dwArgCount, _In_ DWORD dwFlags, _In_ LPCVOID pvData, _Out_ BOOL *pbDone)
typedef struct _CMD_ENTRY	CMD_ENTRY
typedef struct _CMD_ENTRY *	PCMD_ENTRY
typedef struct _CMD_GROUP_ENTRY	CMD_GROUP_ENTRY
typedef struct _CMD_GROUP_ENTRY *	PCMD_GROUP_ENTRY
typedef struct _NS_HELPER_ATTRIBUTES	NS_HELPER_ATTRIBUTES
typedef struct _NS_HELPER_ATTRIBUTES *	PNS_HELPER_ATTRIBUTES
typedef struct _NS_CONTEXT_ATTRIBUTES	NS_CONTEXT_ATTRIBUTES
typedef struct _NS_CONTEXT_ATTRIBUTES *	PNS_CONTEXT_ATTRIBUTES
typedef struct _TAG_TYPE	TAG_TYPE
typedef struct _TAG_TYPE *	PTAG_TYPE
typedef struct _TOKEN_VALUE	TOKEN_VALUE
typedef struct _TOKEN_VALUE *	PTOKEN_VALUE

Enumerations
enum	_NS_REQS { NS_REQ_ZERO = 0 , NS_REQ_PRESENT = 1 , NS_REQ_ALLOW_MULTIPLE = 2 , NS_REQ_ONE_OR_MORE = 3 }
enum	NS_CMD_FLAGS {   CMD_FLAG_PRIVATE = 0x01 , CMD_FLAG_INTERACTIVE = 0x02 , CMD_FLAG_LOCAL = 0x08 , CMD_FLAG_ONLINE = 0x10 ,   CMD_FLAG_HIDDEN = 0x20 , CMD_FLAG_LIMIT_MASK = 0xffff , CMD_FLAG_PRIORITY = 0x80000000 }
enum	NS_MODE_CHANGE {   NETSH_COMMIT = 0 , NETSH_UNCOMMIT = 1 , NETSH_FLUSH = 2 , NETSH_COMMIT_STATE = 3 ,   NETSH_SAVE = 4 }

Functions
DWORD WINAPI	MatchEnumTag (_In_ HANDLE hModule, _In_ LPCWSTR pwcArg, _In_ DWORD dwNumArg, _In_ const TOKEN_VALUE *pEnumTable, _Out_ PDWORD pdwValue)
BOOL WINAPI	MatchToken (_In_ LPCWSTR pwszUserToken, _In_ LPCWSTR pwszCmdToken)
DWORD WINAPI	PreprocessCommand (_In_opt_ HANDLE hModule, _Inout_ LPWSTR *ppwcArguments, _In_ DWORD dwCurrentIndex, _In_ DWORD dwArgCount, _Inout_ PTAG_TYPE pttTags, _In_ DWORD dwTagCount, _In_ DWORD dwMinArgs, _In_ DWORD dwMaxArgs, _Out_ DWORD *pdwTagType)
DWORD CDECL	PrintError (_In_opt_ HANDLE hModule, _In_ DWORD dwErrId,...)
DWORD CDECL	PrintMessageFromModule (_In_ HANDLE hModule, _In_ DWORD dwMsgId,...)
DWORD CDECL	PrintMessage (_In_ LPCWSTR pwszMessage,...)
DWORD WINAPI	RegisterContext (_In_ const NS_CONTEXT_ATTRIBUTES *pChildContext)
DWORD WINAPI	RegisterHelper (_In_ const GUID *pguidParentContext, _In_ const NS_HELPER_ATTRIBUTES *pfnRegisterSubContext)

Macro Definition Documentation

DEFAULT_CONTEXT_PRIORITY

#define DEFAULT_CONTEXT_PRIORITY   100

Definition at line 60 of file netsh.h.

ERROR_CMD_NOT_FOUND

#define ERROR_CMD_NOT_FOUND   (NETSH_ERROR_BASE + 4)

Definition at line 13 of file netsh.h.

ERROR_CONTEXT_ALREADY_REGISTERED

#define ERROR_CONTEXT_ALREADY_REGISTERED   (NETSH_ERROR_BASE + 19)

Definition at line 28 of file netsh.h.

ERROR_CONTINUE_IN_PARENT_CONTEXT

#define ERROR_CONTINUE_IN_PARENT_CONTEXT   (NETSH_ERROR_BASE + 16)

Definition at line 25 of file netsh.h.

ERROR_DLL_LOAD_FAILED

#define ERROR_DLL_LOAD_FAILED   (NETSH_ERROR_BASE + 6)

Definition at line 15 of file netsh.h.

ERROR_ENTRY_PT_NOT_FOUND

#define ERROR_ENTRY_PT_NOT_FOUND   (NETSH_ERROR_BASE + 5)

Definition at line 14 of file netsh.h.

ERROR_HELPER_ALREADY_REGISTERED

#define ERROR_HELPER_ALREADY_REGISTERED   (NETSH_ERROR_BASE + 18)

Definition at line 27 of file netsh.h.

ERROR_INIT_DISPLAY

#define ERROR_INIT_DISPLAY   (NETSH_ERROR_BASE + 7)

Definition at line 16 of file netsh.h.

ERROR_INVALID_OPTION_TAG

#define ERROR_INVALID_OPTION_TAG   (NETSH_ERROR_BASE + 9)

Definition at line 18 of file netsh.h.

ERROR_INVALID_OPTION_VALUE

#define ERROR_INVALID_OPTION_VALUE   (NETSH_ERROR_BASE + 14)

Definition at line 23 of file netsh.h.

ERROR_INVALID_SYNTAX

#define ERROR_INVALID_SYNTAX   (NETSH_ERROR_BASE + 1)

Definition at line 10 of file netsh.h.

ERROR_MISSING_OPTION

#define ERROR_MISSING_OPTION   (NETSH_ERROR_BASE + 11)

Definition at line 20 of file netsh.h.

ERROR_NO_CHANGE

#define ERROR_NO_CHANGE   (NETSH_ERROR_BASE + 3)

Definition at line 12 of file netsh.h.

ERROR_NO_ENTRIES

#define ERROR_NO_ENTRIES   (NETSH_ERROR_BASE + 0)

Definition at line 9 of file netsh.h.

ERROR_NO_TAG

#define ERROR_NO_TAG   (NETSH_ERROR_BASE + 10)

Definition at line 19 of file netsh.h.

ERROR_OKAY

#define ERROR_OKAY   (NETSH_ERROR_BASE + 15)

Definition at line 24 of file netsh.h.

ERROR_PARSING_FAILURE

#define ERROR_PARSING_FAILURE   (NETSH_ERROR_BASE + 20)

Definition at line 29 of file netsh.h.

ERROR_PROTOCOL_NOT_IN_TRANSPORT

#define ERROR_PROTOCOL_NOT_IN_TRANSPORT   (NETSH_ERROR_BASE + 2)

Definition at line 11 of file netsh.h.

ERROR_SHOW_USAGE

#define ERROR_SHOW_USAGE   (NETSH_ERROR_BASE + 13)

Definition at line 22 of file netsh.h.

ERROR_SUPPRESS_OUTPUT

#define ERROR_SUPPRESS_OUTPUT   (NETSH_ERROR_BASE + 17)

Definition at line 26 of file netsh.h.

ERROR_TAG_ALREADY_PRESENT

#define ERROR_TAG_ALREADY_PRESENT   (NETSH_ERROR_BASE + 8)

Definition at line 17 of file netsh.h.

ERROR_TRANSPORT_NOT_PRESENT

#define ERROR_TRANSPORT_NOT_PRESENT   (NETSH_ERROR_BASE + 12)

Definition at line 21 of file netsh.h.

NETSH_ERROR_BASE

#define NETSH_ERROR_BASE   15000

Definition at line 8 of file netsh.h.

NETSH_ERROR_END

#define NETSH_ERROR_END   ERROR_CONTEXT_ALREADY_REGISTERED

Definition at line 30 of file netsh.h.

NETSH_ROOT_GUID

#define NETSH_ROOT_GUID   {0, 0, 0, {0, 0, 0, 0, 0, 0, 0, 0}}

Definition at line 62 of file netsh.h.

Typedef Documentation

CMD_ENTRY

typedef struct _CMD_ENTRY CMD_ENTRY

CMD_GROUP_ENTRY

typedef struct _CMD_GROUP_ENTRY CMD_GROUP_ENTRY

NS_CONTEXT_ATTRIBUTES

typedef struct _NS_CONTEXT_ATTRIBUTES NS_CONTEXT_ATTRIBUTES

NS_HELPER_ATTRIBUTES

typedef struct _NS_HELPER_ATTRIBUTES NS_HELPER_ATTRIBUTES

NS_REQS

typedef enum _NS_REQS NS_REQS

PCMD_ENTRY

typedef struct _CMD_ENTRY * PCMD_ENTRY

PCMD_GROUP_ENTRY

typedef struct _CMD_GROUP_ENTRY * PCMD_GROUP_ENTRY

PFN_HANDLE_CMD

typedef DWORD(WINAPI * PFN_HANDLE_CMD) (_In_ LPCWSTR pwszMachine, _In_ LPWSTR *ppwcArguments, _In_ DWORD dwCurrentIndex, _In_ DWORD dwArgCount, _In_ DWORD dwFlags, _In_ LPCVOID pvData, _Out_ BOOL *pbDone)

Definition at line 119 of file netsh.h.

PGET_RESOURCE_STRING_FN

typedef DWORD(WINAPI * PGET_RESOURCE_STRING_FN) (_In_ DWORD dwMsgID, _Out_ LPWSTR lpBuffer, _In_ DWORD nBufferMax)

Definition at line 65 of file netsh.h.

PNS_CONTEXT_ATTRIBUTES

typedef struct _NS_CONTEXT_ATTRIBUTES * PNS_CONTEXT_ATTRIBUTES

PNS_CONTEXT_COMMIT_FN

typedef DWORD(WINAPI * PNS_CONTEXT_COMMIT_FN) (_In_ DWORD dwAction)

Definition at line 89 of file netsh.h.

PNS_CONTEXT_CONNECT_FN

typedef DWORD(WINAPI * PNS_CONTEXT_CONNECT_FN) (_In_ LPCWSTR pwszMachine)

Definition at line 94 of file netsh.h.

PNS_CONTEXT_DUMP_FN

typedef DWORD(WINAPI * PNS_CONTEXT_DUMP_FN) (_In_ LPCWSTR pwszRouter, _In_ LPWSTR *ppwcArguments, _In_ DWORD dwArgCount, _In_ LPCVOID pvData)

Definition at line 99 of file netsh.h.

PNS_DLL_INIT_FN

typedef DWORD(WINAPI * PNS_DLL_INIT_FN) (_In_ DWORD dwNetshVersion, _Out_ PVOID pReserved)

Definition at line 72 of file netsh.h.

PNS_HELPER_ATTRIBUTES

typedef struct _NS_HELPER_ATTRIBUTES * PNS_HELPER_ATTRIBUTES

PNS_HELPER_START_FN

typedef DWORD(WINAPI * PNS_HELPER_START_FN) (_In_ const GUID *pguidParent, _In_ DWORD dwVersion)

Definition at line 78 of file netsh.h.

PNS_HELPER_STOP_FN

typedef DWORD(WINAPI * PNS_HELPER_STOP_FN) (_In_ DWORD dwReserved)

Definition at line 84 of file netsh.h.

PNS_OSVERSIONCHECK

typedef BOOL(WINAPI * PNS_OSVERSIONCHECK) (_In_ UINT CIMOSType, _In_ UINT CIMOSProductSuite, _In_ LPCWSTR CIMOSVersion, _In_ LPCWSTR CIMOSBuildNumber, _In_ LPCWSTR CIMServicePackMajorVersion, _In_ LPCWSTR CIMServicePackMinorVersion, _In_ UINT uiReserved, _In_ DWORD dwReserved)

Definition at line 107 of file netsh.h.

PTAG_TYPE

typedef struct _TAG_TYPE * PTAG_TYPE

PTOKEN_VALUE

typedef struct _TOKEN_VALUE * PTOKEN_VALUE

TAG_TYPE

typedef struct _TAG_TYPE TAG_TYPE

TOKEN_VALUE

typedef struct _TOKEN_VALUE TOKEN_VALUE

Enumeration Type Documentation

_NS_REQS

enum _NS_REQS

Enumerator
NS_REQ_ZERO
NS_REQ_PRESENT
NS_REQ_ALLOW_MULTIPLE
NS_REQ_ONE_OR_MORE

Definition at line 32 of file netsh.h.

{
    NS_REQ_ZERO = 0,
    NS_REQ_PRESENT = 1,
    NS_REQ_ALLOW_MULTIPLE = 2,
    NS_REQ_ONE_OR_MORE = 3
} NS_REQS;

NS_CMD_FLAGS

enum NS_CMD_FLAGS

Enumerator
CMD_FLAG_PRIVATE
CMD_FLAG_INTERACTIVE
CMD_FLAG_LOCAL
CMD_FLAG_ONLINE
CMD_FLAG_HIDDEN
CMD_FLAG_LIMIT_MASK
CMD_FLAG_PRIORITY

Definition at line 40 of file netsh.h.

{
    CMD_FLAG_PRIVATE     = 0x01,
    CMD_FLAG_INTERACTIVE = 0x02,
    CMD_FLAG_LOCAL       = 0x08,
    CMD_FLAG_ONLINE      = 0x10,
    CMD_FLAG_HIDDEN      = 0x20,
    CMD_FLAG_LIMIT_MASK  = 0xffff,
    CMD_FLAG_PRIORITY    = 0x80000000
};

NS_MODE_CHANGE

enum NS_MODE_CHANGE

Enumerator
NETSH_COMMIT
NETSH_UNCOMMIT
NETSH_FLUSH
NETSH_COMMIT_STATE
NETSH_SAVE

Definition at line 51 of file netsh.h.

{
    NETSH_COMMIT       = 0,
    NETSH_UNCOMMIT     = 1,
    NETSH_FLUSH        = 2,
    NETSH_COMMIT_STATE = 3,
    NETSH_SAVE         = 4
};

Function Documentation

MatchEnumTag()

DWORD WINAPI MatchEnumTag	(	_In_ HANDLE	hModule,
		_In_ LPCWSTR	pwcArg,
		_In_ DWORD	dwNumArg,
		_In_ const TOKEN_VALUE *	pEnumTable,
		_Out_ PDWORD	pdwValue
	)

Definition at line 296 of file netsh.c.

{
    DWORD i;
 
    DPRINT("MatchEnumTag(%p %p %lu %p %p)\n", hModule, pwcArg, dwNumArg, pEnumTable, pdwValue);
 
    if ((pEnumTable == NULL) || (pdwValue == NULL))
        return ERROR_INVALID_PARAMETER;
 
    for (i = 0; i < dwNumArg; i++)
    {
        if (MatchToken(pwcArg, pEnumTable[i].pwszToken))
        {
            *pdwValue = pEnumTable[i].dwValue;
            return ERROR_SUCCESS;
        }
    }
 
    return ERROR_NOT_FOUND;
}

MatchToken()

BOOL WINAPI MatchToken	(	_In_ LPCWSTR	pwszUserToken,
		_In_ LPCWSTR	pwszCmdToken
	)

Definition at line 324 of file netsh.c.

{
    DPRINT("MatchToken(%S %S)\n", pwszUserToken, pwszCmdToken);
 
    if ((pwszUserToken == NULL) || (pwszCmdToken == NULL))
        return FALSE;
 
    return (_wcsnicmp(pwszUserToken, pwszCmdToken, wcslen(pwszUserToken)) == 0) ? TRUE : FALSE;
}

Referenced by GetContextCommand(), GetContextGroup(), GetContextSubContext(), GetGroupCommand(), IpShowAdapters(), and MatchEnumTag().

PreprocessCommand()

DWORD WINAPI PreprocessCommand	(	_In_opt_ HANDLE	hModule,
		_Inout_ LPWSTR *	ppwcArguments,
		_In_ DWORD	dwCurrentIndex,
		_In_ DWORD	dwArgCount,
		_Inout_ PTAG_TYPE	pttTags,
		_In_ DWORD	dwTagCount,
		_In_ DWORD	dwMinArgs,
		_In_ DWORD	dwMaxArgs,
		_Out_ DWORD *	pdwTagType
	)

PrintError()

DWORD CDECL PrintError	(	_In_opt_ HANDLE	hModule,
		_In_ DWORD	dwErrId,
			...
	)

Definition at line 392 of file netsh.c.

{
    PWSTR pszInBuffer = NULL, pszOutBuffer = NULL;
    DWORD dwLength = 0;
    va_list ap;
 
    DPRINT("PrintError(%p %lu ...)\n", hModule, dwErrId);
 
    va_start(ap, dwErrId);
 
    pszOutBuffer = HeapAlloc(GetProcessHeap(), 0, HUGE_BUFFER_SIZE * sizeof(WCHAR));
    if (pszOutBuffer == NULL)
        goto done;
 
    if (hModule)
    {
        pszInBuffer = HeapAlloc(GetProcessHeap(), 0, HUGE_BUFFER_SIZE * sizeof(WCHAR));
        if (pszInBuffer == NULL)
            goto done;
 
        dwLength = LoadStringW(hModule, dwErrId, pszInBuffer, HUGE_BUFFER_SIZE);
        if (dwLength == 0)
            goto done;
 
        dwLength = FormatMessageW(FORMAT_MESSAGE_FROM_STRING,
                                  pszInBuffer,
                                  0,
                                  0,
                                  pszOutBuffer,
                                  HUGE_BUFFER_SIZE,
                                  &ap);
    }
    else
    {
        if ((dwErrId > NETSH_ERROR_BASE) && (dwErrId < NETSH_ERROR_END))
        {
            pszInBuffer = HeapAlloc(GetProcessHeap(), 0, HUGE_BUFFER_SIZE * sizeof(WCHAR));
            if (pszInBuffer == NULL)
                goto done;
 
            dwLength = LoadStringW(GetModuleHandle(NULL), dwErrId, pszInBuffer, HUGE_BUFFER_SIZE);
            if (dwLength == 0)
                goto done;
 
            dwLength = FormatMessageW(FORMAT_MESSAGE_FROM_STRING,
                                      pszInBuffer,
                                      0,
                                      0L,
                                      pszOutBuffer,
                                      HUGE_BUFFER_SIZE,
                                      &ap);
        }
        else
        {
            dwLength = FormatMessageW(FORMAT_MESSAGE_FROM_SYSTEM,
                                      NULL,
                                      dwErrId,
                                      MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
                                      pszOutBuffer,
                                      HUGE_BUFFER_SIZE,
                                      &ap);
        }
    }
 
    va_end(ap);
 
    if (dwLength > 0)
        ConPuts(StdOut, pszOutBuffer);
 
done:
    if (pszOutBuffer)
        HeapFree(GetProcessHeap(), 0, pszOutBuffer);
 
    if (pszInBuffer)
        HeapFree(GetProcessHeap(), 0, pszInBuffer);
 
    return dwLength;
}

Referenced by wmain().

PrintMessage()

DWORD CDECL PrintMessage	(	_In_ LPCWSTR	pwszMessage,
			...
	)

Definition at line 495 of file netsh.c.

{
    INT Length;
    va_list ap;
 
    va_start(ap, pwszFormat);
    Length = ConPrintfV(StdOut, pwszFormat, ap);
    va_end(ap);
 
    return Length;
}

PrintMessageFromModule()

DWORD CDECL PrintMessageFromModule	(	_In_ HANDLE	hModule,
		_In_ DWORD	dwMsgId,
			...
	)

Definition at line 476 of file netsh.c.

{
    INT Length;
    va_list ap;
 
    va_start(ap, dwMsgId);
    Length = ConResPrintfExV(StdOut, hModule, dwMsgId,
                             MAKELANGID(LANG_NEUTRAL, SUBLANG_NEUTRAL),
                             ap);
    va_end(ap);
 
    return Length;
}

Referenced by InterfaceDumpFn(), IpDumpFn(), and IpShowAdapters().

RegisterContext()

DWORD WINAPI RegisterContext

(

_In_ const NS_CONTEXT_ATTRIBUTES *

pChildContext

)

Definition at line 909 of file context.c.

{
    PHELPER_ENTRY pHelper;
    PCONTEXT_ENTRY pContext, pParentContext;
    PCOMMAND_GROUP pGroup;
    DWORD i, j;
 
    DPRINT1("RegisterContext(%p)\n", pChildContext);
    if (pChildContext == NULL)
    {
        DPRINT1("Invalid child context!\n");
        return ERROR_INVALID_PARAMETER;
    }
 
    if ((pChildContext->pwszContext == NULL) ||
        (wcslen(pChildContext->pwszContext) == 0) ||
        (wcschr(pChildContext->pwszContext, L' ') != 0) ||
        (wcschr(pChildContext->pwszContext, L'=') != 0))
    {
        DPRINT1("Invalid context name!\n");
        return ERROR_INVALID_PARAMETER;
    }
 
    DPRINT("Name: %S\n", pChildContext->pwszContext);
    DPRINT("Groups: %lu\n", pChildContext->ulNumGroups);
    DPRINT("Top commands: %lu\n", pChildContext->ulNumTopCmds);
 
    pHelper = FindHelper(&pChildContext->guidHelper, pHelperListHead);
    DPRINT("Helper %p\n", pHelper);
    pParentContext = pRootContext;
    if (pHelper != NULL)
    {
        pParentContext = FindContextByGuid(&pHelper->ParentHelperGuid);
        DPRINT("pParentContext %p\n", pParentContext);
        if (pParentContext == NULL)
            pParentContext = pRootContext;
    }
 
    pContext = AddContext(pParentContext, pChildContext->pwszContext, (GUID*)&pChildContext->guidHelper);
    if (pContext != NULL)
    {
        pContext->pfnCommitFn = pChildContext->pfnCommitFn;
        pContext->pfnDumpFn = pChildContext->pfnDumpFn;
        pContext->pfnConnectFn = pChildContext->pfnConnectFn;
        pContext->ulPriority = (pChildContext->dwFlags & CMD_FLAG_PRIORITY) ?
                               pChildContext->ulPriority : DEFAULT_CONTEXT_PRIORITY;
 
        if ((pHelper != NULL) && (pHelper->pDllEntry != NULL))
        {
            pContext->hModule = pHelper->pDllEntry->hModule;
        }
 
        for (i = 0; i < pChildContext->ulNumTopCmds; i++)
        {
            AddContextCommand(pContext,
                              pChildContext->pTopCmds[i].pwszCmdToken,
                              pChildContext->pTopCmds[i].pfnCmdHandler,
                              pChildContext->pTopCmds[i].dwShortCmdHelpToken,
                              pChildContext->pTopCmds[i].dwCmdHlpToken,
                              pChildContext->pTopCmds[i].dwFlags);
        }
 
        /* Add command groups */
        for (i = 0; i < pChildContext->ulNumGroups; i++)
        {
            pGroup = AddCommandGroup(pContext,
                                     pChildContext->pCmdGroups[i].pwszCmdGroupToken,
                                     pChildContext->pCmdGroups[i].dwShortCmdHelpToken,
                                     pChildContext->pCmdGroups[i].dwFlags);
            if (pGroup != NULL)
            {
                for (j = 0; j < pChildContext->pCmdGroups[i].ulCmdGroupSize; j++)
                {
                    AddGroupCommand(pGroup,
                                    pChildContext->pCmdGroups[i].pCmdGroup[j].pwszCmdToken,
                                    pChildContext->pCmdGroups[i].pCmdGroup[j].pfnCmdHandler,
                                    pChildContext->pCmdGroups[i].pCmdGroup[j].dwShortCmdHelpToken,
                                    pChildContext->pCmdGroups[i].pCmdGroup[j].dwCmdHlpToken,
                                    pChildContext->pCmdGroups[i].pCmdGroup[j].dwFlags);
                }
            }
        }
    }
 
    return ERROR_SUCCESS;
}

Referenced by InterfaceStart(), and IpStart().

RegisterHelper()

DWORD WINAPI RegisterHelper	(	_In_ const GUID *	pguidParentContext,
		_In_ const NS_HELPER_ATTRIBUTES *	pfnRegisterSubContext
	)

Definition at line 385 of file helper.c.

{
    PHELPER_ENTRY pHelper = NULL, pParentHelper;
    DWORD dwError = ERROR_SUCCESS;
 
    DPRINT("RegisterHelper(%p %p)\n", pguidParentHelper, pHelperAttributes);
 
    if (FindHelper(&pHelperAttributes->guidHelper, pHelperListHead) != NULL)
    {
        DPRINT1("The Helper has already been registered!\n");
        return ERROR_INVALID_PARAMETER;
    }
 
    pHelper = (PHELPER_ENTRY)HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(HELPER_ENTRY));
    if (pHelper == NULL)
    {
        dwError = ERROR_OUTOFMEMORY;
        goto done;
    }
 
    DPRINT("Guid: %lx\n", pHelperAttributes->guidHelper.Data1);
    DPRINT("dwVersion: %lu\n", pHelperAttributes->dwVersion);
    DPRINT("pfnStart: %p\n", pHelperAttributes->pfnStart);
    DPRINT("pfnStop: %p\n", pHelperAttributes->pfnStop);
 
    CopyMemory(&pHelper->Attributes, pHelperAttributes, sizeof(NS_HELPER_ATTRIBUTES));
    pHelper->pDllEntry = pCurrentDll;
    DPRINT("pHelper->pDllEntry: %p\n", pHelper->pDllEntry);
 
    if (pguidParentHelper == NULL)
    {
        if ((pHelperListHead == NULL) && (pHelperListTail == NULL))
        {
            pHelperListHead = pHelper;
            pHelperListTail = pHelper;
        }
        else
        {
            pHelper->pNext = pHelperListHead;
            pHelperListHead->pPrev = pHelper;
            pHelperListHead = pHelper;
        }
    }
    else
    {
        CopyMemory(&pHelper->ParentHelperGuid, pguidParentHelper, sizeof(GUID));
        pParentHelper = FindHelper(pguidParentHelper, pHelperListHead);
        if (pParentHelper == NULL)
        {
            DPRINT("Parent helper %lx not found!\n", pguidParentHelper->Data1);
            return ERROR_INVALID_PARAMETER;
        }
 
        if ((pParentHelper->pSubHelperHead == NULL) && (pParentHelper->pSubHelperTail == NULL))
        {
            pParentHelper->pSubHelperHead = pHelper;
            pParentHelper->pSubHelperTail = pHelper;
        }
        else
        {
            pHelper->pPrev = pParentHelper->pSubHelperTail;
            pParentHelper->pSubHelperTail->pNext = pHelper;
            pParentHelper->pSubHelperTail = pHelper;
        }
    }
 
done:
 
    return dwError;
}

Referenced by RegisterInterfaceHelper(), and RegisterIpHelper().