MprAdminInterfaceDelete function (mprapi.h)

The MprAdminInterfaceDelete function deletes an interface on a specified server.

Syntax

DWORD MprAdminInterfaceDelete(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface
);

Parameters

[in] hMprServer

Handle to the router on which to execute this call. Obtain this handle by calling MprAdminServerConnect.

[in] hInterface

Handle to the interface to delete. Obtain this handle by calling MprAdminInterfaceCreate.

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_ACCESS_DENIED
The calling application does not have sufficient privileges.
ERROR_INTERFACE_CONNECTED
The interface specified is a demand-dial interface and is currently connected.
ERROR_INVALID_HANDLE
The hInterface value is invalid.
 
 

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

MprAdminInterfaceCreate

MprAdminServerConnect

Router Administration Functions

Router Management Reference