MprAdminRegisterConnectionNotification function (mprapi.h)

Article
02/22/2024

The MprAdminRegisterConnectionNotification function registers an event object with the Demand Dial Manager (DDM) so that, if an interface connects or disconnects, the event is signaled.

Syntax

DWORD MprAdminRegisterConnectionNotification(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hEventNotification
);

Parameters

[in] hMprServer

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

[in] hEventNotification

Handle to an event object. This event is signaled whenever an interface connects or disconnects.

Return value

If the function is successful, 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_DDM_NOT_RUNNING	The Demand Dial Manager (DDM) is not running.
ERROR_INVALID_PARAMETER	The hEventNotification parameter is NULL or is an invalid handle.
Other	Use FormatMessage to retrieve the system error message that corresponds to the error code returned.

Remarks

The event is signaled when an interface connects or disconnects. When an event is signaled, the calling application can determine which interface is affected by using a function such as MprAdminConnectionEnum or MprAdminInterfaceEnum.

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