3.1.4.43 RRasAdminConnectionRemoveQuarantine (Opnum 42)

  • Article

The RRasAdminConnectionRemoveQuarantine method<314> removes quarantine filters on a dialed-in RRAS client if the filters were applied as a result of Internet Authentication Service (IAS) policies. This function does not remove the IPv6 quarantine filters. The hDimServer handle specifies the RRASM server on which the call is to be executed.<315> 

 DWORD RRasAdminConnectionRemoveQuarantine(
   [in] DIM_HANDLE hDimServer,
   [in] DWORD hRasConnection,
   [in] BOOL fIsIpAddress
 );

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

hRasConnection: This is of type DWORD and SHOULD be set to a particular connection identifier for which the connection information is required. Obtain this handle by calling RRasAdminConnectionEnum (section 3.1.4.2). Since the RRASM server does not maintain the connection handles, the RRAS server SHOULD check and ensure that this handle is a valid connection handle.

Alternatively, this parameter specifies the IP address of the RRAS client for which to remove the quarantine filter. The IP address MUST be specified as a DWORD in network byte order. Obtain the IP address by calling RRasAdminConnectionEnum. If this parameter specifies an IP address, the fIsIpAddress parameter MUST specify a TRUE value.

fIsIpAddress: Specifies a Boolean value that indicates whether the hRasConnection parameter specifies the IP address of the client for which to remove the quarantine filters. If this parameter is a TRUE value, hRasConnection specifies an IP address. Otherwise, hRasConnection specifies a handle to a connection.

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 42.

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 is a member of the "Administrator Group". If not, then return error ERROR_ACCESS_DENIED (0x00000005).

  • 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 the RRAS server returns while processing the request. Otherwise return ERROR_SUCCESS (0x00000000).

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