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

Typedefs
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

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_ 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)

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

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 63 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 9 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 33 of file netsh.h.

PNS_CONTEXT_CONNECT_FN

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

Definition at line 38 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 43 of file netsh.h.

PNS_DLL_INIT_FN

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

Definition at line 16 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 22 of file netsh.h.

PNS_HELPER_STOP_FN

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

Definition at line 28 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 51 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

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 197 of file netsh.c.

{
    DPRINT1("MatchEnumTag()\n");
    return 0;
}

MatchToken()

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

Definition at line 210 of file netsh.c.

{
    DPRINT1("MatchToken %S %S\n", pwszUserToken, pwszCmdToken);
    return (_wcsicmp(pwszUserToken, pwszCmdToken) == 0) ? TRUE : FALSE;
}

PreprocessCommand()

DWORD WINAPI PreprocessCommand	(	_In_ 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 220 of file netsh.c.

{
    DPRINT1("PrintError()\n");
    return 1;
}

PrintMessage()

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

Definition at line 242 of file netsh.c.

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

PrintMessageFromModule()

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

Definition at line 231 of file netsh.c.

{
    DPRINT1("PrintMessageFromModule()\n");
    return 1;
}

RegisterContext()

DWORD WINAPI RegisterContext

(

_In_ const NS_CONTEXT_ATTRIBUTES *

pChildContext

)

Definition at line 326 of file context.c.

{
    PCONTEXT_ENTRY pContext;
    DWORD i;
 
    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;
    }
 
    DPRINT1("Name: %S\n", pChildContext->pwszContext);
 
    pContext = AddContext(pRootContext, pChildContext->pwszContext, (GUID*)&pChildContext->guidHelper);
    if (pContext != NULL)
    {
        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++)
        {
            AddCommandGroup(pContext,
                pChildContext->pCmdGroups[i].pwszCmdGroupToken,
                pChildContext->pCmdGroups[i].dwShortCmdHelpToken,
                pChildContext->pCmdGroups[i].dwFlags);
        }
    }
 
    return ERROR_SUCCESS;
}

RegisterHelper()

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

Definition at line 358 of file helper.c.

{
    PHELPER_ENTRY pHelper = NULL, pParentHelper;
    DWORD dwError = ERROR_SUCCESS;
 
    DPRINT("RegisterHelper(%p %p)\n", pguidParentHelper, pHelperAttributes);
 
    if (FindHelper(&pHelperAttributes->guidHelper) != NULL)
    {
        DPRINT1("The Helper has already been registered!\n");
        return 1;
    }
 
    pHelper = (PHELPER_ENTRY)HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(HELPER_ENTRY));
    if (pHelper == NULL)
    {
        dwError = ERROR_OUTOFMEMORY;
        goto done;
    }
 
    CopyMemory(&pHelper->Attributes, pHelperAttributes, sizeof(NS_HELPER_ATTRIBUTES));
    pHelper->pDllEntry = pCurrentDll;
    DPRINT("pHelper->pDllEntry: %p\n", pHelper->pDllEntry);
 
    if (pguidParentHelper == NULL)
    {
        if (pHelperListTail == NULL)
        {
            pHelperListHead = pHelper;
            pHelperListTail = pHelper;
        }
        else
        {
            pHelper->pNext = pHelperListHead;
            pHelperListHead->pPrev = pHelper;
            pHelperListHead = pHelper;
        }
    }
    else
    {
        pParentHelper = FindHelper(&pHelperAttributes->guidHelper);
        if (pParentHelper == NULL)
            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;
}