MprConfigInterfaceCreate function (mprapi.h)

Article
02/22/2024

The MprConfigInterfaceCreate function creates a router interface in the specified router configuration.

Syntax

DWORD MprConfigInterfaceCreate(
  [in]  HANDLE hMprConfig,
  [in]  DWORD  dwLevel,
  [in]  LPBYTE lpbBuffer,
  [out] HANDLE *phRouterInterface
);

Parameters

[in] hMprConfig

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

[in] dwLevel

A DWORD value that describes the format in which the information is structured in the lpbBuffer parameter. Acceptable values for dwLevel include 0, 1, 2, and 3, as listed in the following table.

Value	Structure Format
0	MPR_INTERFACE_0
1	MPR_INTERFACE_1
2	MPR_INTERFACE_2
3	Windows Server 2008 or later: MPR_INTERFACE_3

[in] lpbBuffer

A pointer to a MPR_INTERFACE_0, MPR_INTERFACE_1,
MPR_INTERFACE_2, or MPR_INTERFACE_3 structure. The dwLevel parameter indicates the type of structure.

[out] phRouterInterface

Pointer to a handle variable. This variable receives a handle to the interface configuration.

Return value

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	At least one of the following is true: hMprConfig is NULL dwLevel is not 0, 1, 2, or 3. lpbBuffer is NULL phRouterInterface is NULL
ERROR_NOT_ENOUGH_MEMORY	Insufficient resources to complete the operation.
Other	Use FormatMessage to retrieve the system error message that corresponds to the error code returned.

Remarks

The MprAdminInterfaceCreate function supports the MPR_INTERFACE_2 structure. However, MprConfigInterfaceCreate does not. In order to create a demand-dial interface that is persistent after a reboot, call MprAdminInterfaceCreate with MPR_INTERFACE_2, then call MprConfigInterfaceCreate with MPR_INTERFACE_0 or MPR_INTERFACE_1.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	mprapi.h
Library	Mprapi.lib
DLL	Mprapi.dll