Skip to content

Latest commit

 

History

History
192 lines (137 loc) · 5.05 KB

nf-mprapi-mprconfiginterfaceenum.md

File metadata and controls

192 lines (137 loc) · 5.05 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:mprapi.MprConfigInterfaceEnum
MprConfigInterfaceEnum function (mprapi.h)
The MprConfigInterfaceEnum function enumerates the interfaces that are configured for the router.
MprConfigInterfaceEnum
MprConfigInterfaceEnum function [RAS]
_mpr_mprconfiginterfaceenum
mprapi/MprConfigInterfaceEnum
rras.mprconfiginterfaceenum
rras\mprconfiginterfaceenum.htm
RRAS
fce40bcc-df75-49cd-af02-5fea3a65aaac
12/05/2018
MprConfigInterfaceEnum, MprConfigInterfaceEnum function [RAS], _mpr_mprconfiginterfaceenum, mprapi/MprConfigInterfaceEnum, rras.mprconfiginterfaceenum
mprapi.h
Windows
None supported
Windows 2000 Server [desktop apps only]
Mprapi.lib
Mprapi.dll
Windows
19H1
MprConfigInterfaceEnum
mprapi/MprConfigInterfaceEnum
c++
APIRef
kbSyntax
DllExport
Mprapi.dll
MprConfigInterfaceEnum

MprConfigInterfaceEnum function

-description

The MprConfigInterfaceEnum function enumerates the interfaces that are configured for the router.

-parameters

-param hMprConfig [in]

Handle to the router configuration. Obtain this handle by calling MprConfigServerConnect.

-param dwLevel [in]

A DWORD value that describes the format in which the information is returned in the lplpBuffer parameter. Must be zero.

-param lplpBuffer [in, out]

On input, a non-NULL pointer.

On successful completion, a pointer to an array of MPR_INTERFACE_0 structures. Free this memory buffer by calling MprConfigBufferFree.

-param dwPrefMaxLen [in]

Specifies the preferred maximum length of returned data (in 8-bit bytes). If this parameter is -1, the buffer returned will be large enough to hold all available information.

-param lpdwEntriesRead [out]

Pointer to a DWORD variable. This variable receives the total number of entries that were enumerated from the current resume position.

-param lpdwTotalEntries [out]

Pointer to a DWORD variable. This variable receives the total number of entries that could have been enumerated from the current resume position.

-param lpdwResumeHandle [in, out, optional]

Pointer to a DWORD variable.

On input, the handle should be zero on the first call, and left unchanged on subsequent calls to continue the enumeration.

On output, contains a resume handle that can be used to continue the enumeration. If the handle is NULL, the enumeration is complete.

If an error occurs in the enumeration, this handle is invalid.

This parameter is optional. If the calling application specifies NULL for this parameter, the function does not return a resume handle.

-returns

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value Meaning
ERROR_INVALID_PARAMETER
 One of the following is true:
  • hMprConfig is NULL.
  • dwLevel is not zero.
  • lplpBuffer is NULL.
  • dwPrefMaxLen is smaller than the size of a single MPR_INTERFACE_0 structure.
  • lpdwEntriesRead is NULL.
  • lpdwTotalEntries is NULL.
ERROR_NOT_ENOUGH_MEMORY
 Insufficient resources to complete the operation.
ERROR_NO_MORE_ITEMS
 No more entries available from the current resume position.
Other
 Use FormatMessage to retrieve the system error message that corresponds to the error code returned.

-see-also

FormatMessage

MprConfigBufferFree

MprConfigServerConnect

Router Configuration Functions

Router Management Reference