Share via

3.1.4.49 RRasAdminUpdateConnection (Opnum 48)

  • Article

The RRasAdminUpdateConnection method<325> updates the endpoint by sending MOBIKE on a connection specified by hDimConnection on a specified server, hDimServer.

 DWORD RRasAdminUpdateConnection(
   [in] DIM_HANDLE hDimServer,
   [in] DWORD hDimConnection,
   [in] PRAS_UPDATE_CONNECTION_IDL pServerConfig
 );

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

hDimConnection: This is of type DWORD and SHOULD be set to a particular IKEv2 connection identifier for which the endpoint needs to be updated. Obtain this handle by calling RRasAdminConnectionEnum (see section 3.1.4.2). Since the RRASM server does not maintain connection handles, the RRAS server SHOULD validate this handle.

pServerConfig: This is a pointer to a RAS_UPDATE_CONNECTION_IDL structure (section 2.2.1.2.148) that contains the information required to set values on the RRAS server.

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, the return value contains an error code, as specified in [MS-ERREF] or in section 2.2.4. All values that are not included 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 48.

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 the client does not have access, 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 status the RRAS server returns. Otherwise return ERROR_SUCCESS (0x00000000).

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