3.1.4.45 RMprAdminServerGetInfoEx (Opnum 44)

  • Article

The RMprAdminServerGetInfoEx method<319> gets the device configuration information for PPTP, L2TP, SSTP, and IKEv2 on a server specified by hDimServer. 

 DWORD RMprAdminServerGetInfoEx(
   [in] DIM_HANDLE hDimServer,
   [in, out] PMPR_SERVER_EX_IDL pServerConfig
 );

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

pServerConfig: A valid pointer to an MPR_SERVER_EX_IDL structure (section 2.2.1.2.143). This MUST NOT be NULL. On successful return this parameter contains port information for RRAS.

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

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.

  • When the RRAS server processes the request successfully, populate pServerConfig with the information returned by RRAS server and return ERROR_SUCCESS (0x00000000). Otherwise return the error status provided by the RRAS server.

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