MprConfigInterfaceDelete

[This is preliminary documentation and subject to change.]

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

DWORD  MprConfigInterfaceDelete(
  HANDLE hMprConfig,         // handle to the router configuration
  HANDLE hRouterInterface    // handle to the interface configuration
);

Parameters

hMprConfig

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

hRouterInterface

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

Return Values

NO_ERROR

The router interface was deleted successfully.

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 corresponding to the error code returned.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in mprapi.h.
  Import Library: Link with mprapi.lib.

See Also

FormatMessage, MprConfigInterfaceCreate, MprConfigInterfaceEnum, MprConfigInterfaceGetHandle, MprConfigServerConnect