Partager via

3.1.4.25 RRouterInterfaceQueryUpdateResult (Opnum 24)

  • Article

The RRouterInterfaceQueryUpdateResult method<284> returns the result of the last RRouterInterfaceUpdateRoutes (section 3.1.4.24) request of the RRAS server for a specified transport to update its routes for an interface. This method MUST be called only once after RRouterInterfaceUpdateRoutes.   

 DWORD RRouterInterfaceQueryUpdateResult(
   [in] DIM_HANDLE hDimServer,
   [in] DWORD hInterface,
   [in] DWORD dwTransportId,
   [out] LPDWORD pUpdateResult
 );

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 identifier can be obtained from RRouterInterfaceCreate (section 3.1.4.13) or RRouterInterfaceGetHandle (section 3.1.4.12). Because the RRASM server does not maintain interface handles, the RRAS server SHOULD check and ensure that this handle represents a valid interface handle.  

dwTransportId: Specifies the transport for which routing information needs to be updated. This MUST be one of the following values.<285> Otherwise an error is returned.

Value

Meaning

PID_IPX

0x0000002B

IPX protocol

PID_IP

0x00000021

IPv4 protocol

pUpdateResult: A pointer to a DWORD variable. This variable receives the result of the last call to RRouterInterfaceUpdateRoutes; see the return values of RRouterInterfaceUpdateRoutes.

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 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, as specified in section 2.1.1.1.

The opnum field value for this method is 24.

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 dwTransportId is not specified in the SupportedTransportsList, return an error other than those specified 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 processes the request successfully, update the pUdateResult with the information provided by RRAS server and return ERROR_SUCCESS (0x00000000). Otherwise return the error status that the RRAS server returns.

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