MprAdminInterfaceUpdatePhonebookInfo

The MprAdminInterfaceUpdatePhonebookInfo function forces the router to pick up changes made on a specified demand-dial interface. Call this function after making changes to a phone-book entry for a demand-dial interface.

DWORD MprAdminInterfaceUpdatePhonebookInfo(
  MPR_SERVER_HANDLE hMprServer,  // handle to the router
  HANDLE hInterface              // handle to the interface
);

Parameters

hMprServer
[in] Handle to the Windows 2000 router on which to execute this call. Obtain the handle by calling MprAdminServerConnect.
hInterface
[in] Handle to a demand-dial interface. Obtain this handle by calling MprAdminInterfaceCreate.

Return Values

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_CANNOT_LOAD_PHONEBOOK The function could not load the phone book into memory.
ERROR_CANNOT_OPEN_PHONEBOOK The function could not find the phone-book file.
ERROR_DDM_NOT_RUNNING The Demand Dial Manager (DDM) is not running.
ERROR_INTERFACE_HAS_NO_DEVICES No device is currently associated with this interface.
ERROR_INVALID_HANDLE The hInterface value is invalid.
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

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Mprapi.h.
  Library: Use Mprapi.lib.

See Also

Router Management Reference, Router Administration Functions, FormatMessage, MprAdminInterfaceCreate, MprAdminServerConnect