MprAdminInterfaceUpdatePhonebookInfo

[This is preliminary documentation and subject to change.]

Call the MprAdminInterfaceUpdatePhonebookInfo function after making any changes to the phonebook entry for the specified demand dial interface. This function forces the router to pick up the changes for that interface.

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

Parameters

hMprServer

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

hInterface

Handle to a demand-dial interface. Obtain this handle by calling MprAdminInterfaceCreate.

Return Values

NO_ERROR

The phonebook information was updated successfully.

ERROR_ACCESS_DENIED

The caller does not have sufficient privilege.

ERROR_CANNOT_LOAD_PHONEBOOK

The function could not load the phonebook into memory.

ERROR_CANNOT_OPEN_PHONEBOOK

The function could not find the phonebook 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 carry out the operation.

Other

Use FormatMessage to retrieve the system error message corresponding to the error code returned.

See Also

FormatMessage, MprAdminInterfaceCreate, MprAdminServerConnect