3.1.4.35 RRasAdminConnectionNotification (Opnum 34)

  • Article

The RRasAdminConnectionNotification method<302> registers an event object with the RRAS server so that, if an interface connects or disconnects, the event is signaled. The hDimServer handle specifies on which RRAS server the call is to be executed.

 DWORD RRasAdminConnectionNotification(
   [in] DIM_HANDLE hDimServer,
   [in] DWORD fRegister,
   [in] DWORD dwClientProcessId,
   [in] ULONG_PTR hEventNotification
 );

hDimServer: A handle to the RRASM server where the call is to be executed, see section 3.1.3.

fRegister: This is of type DWORD and SHOULD be set to 1, if notifications are required when an interface is connected or disconnected. Set to 0 to unregister notifications.

dwClientProcessId: The current process identifier that determines where the function is called from.

hEventNotification: A handle to an event that is signaled after the connection is connected or disconnected. This MUST be a handle to an event on the RRASM server which is created within the process specified by dwClientProcessId which can be signaled on interface connect and disconnect events. Otherwise the method SHOULD fail with an appropriate error code as specified in [MS-ERREF].

Return Values: A 32-bit, unsigned integer value that indicates return status. A return value of ERROR_SUCCESS (0x00000000) indicates that the operation was completed successfully; otherwise, it contains an error code, as specified in [MS-ERREF] or in section 2.2.4. All values that are not in the table that follows MUST be treated the same by the RRASM client.

Return value/code

Description

ERROR_SUCCESS

0x00000000

The call was successful.

ERROR_ACCESS_DENIED

0x00000005

The calling application does not have sufficient privileges.

The opnum field value for this method is 34.

When processing this call, the RRASM server MUST do the following:

  • Validate, as specified in section 2.1.1.1, whether this method was called by a client that has access to the method. If not, then return error ERROR_ACCESS_DENIED.

  • If hEventNotification is NULL, return an error other than those specified in the preceding table.

  • If RouterType is ROUTER_TYPE_LAN, return an error other than those in the preceding table.

  • Call the abstract interface Invoke DIMSVC method specifying the operation and the parameters to enable RRAS server to perform the required management task.

  • Return any error status the RRAS server might return while processing the request. Otherwise return ERROR_SUCCESS.

No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].