Partager via

3.1.4.52 RRouterInterfaceGetCustomInfoEx (Opnum 51)

  • Article

The RRouterInterfaceGetCustomInfoEx method<328> is used to get the tunnel-specific custom configuration for an interface.

 DWORD RRouterInterfaceGetCustomInfoEx(
   [in] DIM_HANDLE hDimServer,
   [in] DWORD hInterface,
   [in, out] PMPR_IF_CUSTOMINFOEX_IDL pIfCustomConfig
 );

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

hInterface: The unique identifier of an interface. This can be obtained from RRouterInterfaceCreate (section 3.1.4.13) or RRouterInterfaceGetHandle (section 3.1.4.12). Because the RRASM server does not maintain the interface handles, the RRAS server SHOULD check to ensure that this handle represents a valid interface handle.

pIfCustomConfig: A valid pointer to an MPR_IF_CUSTOMINFOEX_IDL (section 2.2.1.2.245) structure. This MUST NOT be NULL. On successful return, this parameter contains tunnel-specific custom configuration for the interface whose handle is specified in the hInterface parameter. 

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.

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, return the error ERROR_ACCESS_DENIED (0x00000005).

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

  • Return any error status that the RRAS server returns. Otherwise, return ERROR_SUCCESS (0x00000000).

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