Share via

3.1.4.48 RMprAdminServerSetInfoEx (Opnum 47)

  • Article

The RMprAdminServerSetInfoEx method<322> sets the device configuration information for PPTP, L2TP, SSTP, and IKEv2 on a specified server hDimServer.

 DWORD RMprAdminServerSetInfoEx(
   [in] DIM_HANDLE hDimServer,
   [in] PMPR_SERVER_SET_CONFIG_EX_IDL pServerConfig
 );

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

pServerConfig: This is a pointer to a structure PMPR_SERVER_SET_CONFIG_EX_IDL (section 2.2.1.2.146) which contains the information required to set values on the RAS server.

Return Values: A 32-bit unsigned integer value that indicates return status. A return value of ERROR_SUCCESS (0x00000000) indicates the operation was completed successfully; otherwise, it contains an error code, as specified in [MS-ERREF] or in section 2.2.4. All values 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.

ERROR_SUCCESS_REBOOT_REQUIRED

0x00000BC2

A system reboot is required for such a change to take effect.

ERROR_SUCCESS_RESTART_REQUIRED

0x00000BC3

A remote access service restart is required for such a change to take effect.

The opnum field value for this method is 47.

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

  • If pServerConfig is NULL, 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.

  • If the RRAS server completes the processing successfully, it MUST return either ERROR_SUCCESS, ERROR_SUCCESS_REBOOT_REQUIRED<323>, or ERROR_RESTART_REQUIRED<324> based on the impact of the configuration change. Otherwise return the error status.

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