Edit

MprConfigInterfaceDelete function (mprapi.h)

  • Article

The MprConfigInterfaceDelete function removes a router interface from the router configuration. All transport information associated with this interface is also removed.

Syntax

DWORD MprConfigInterfaceDelete(
  [in] HANDLE hMprConfig,
  [in] HANDLE hRouterInterface
);

Parameters

[in] hMprConfig

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

[in] hRouterInterface

Handle to the interface configuration. Obtain this handle by calling MprConfigInterfaceCreate, MprConfigInterfaceGetHandle, or MprConfigInterfaceEnum.

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
 The hMprConfig parameter is NULL, or the hRouterInterface parameter is NULL, or both parameters are 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.
 
 

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

See also

FormatMessage

MprConfigInterfaceCreate

MprConfigInterfaceEnum

MprConfigInterfaceGetHandle

MprConfigServerConnect

Router Configuration Functions

Router Management Reference