Share via

3.1.4.10 RRouterInterfaceTransportSetGlobalInfo (Opnum 9)

  • Article

The RRouterInterfaceTransportSetGlobalInfo method<254> is used to set global information, for the specified transport (IPX, IPv4, or IPv6), such as disabling IPv6 filtering.

 DWORD RRouterInterfaceTransportSetGlobalInfo(
   [in] DIM_HANDLE hDimServer,
   [in] DWORD dwTransportId,
   [in] PDIM_INTERFACE_CONTAINER pInfoStruct
 );

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

dwTransportId: Specifies the transport for which the information is set (IPX, IPv4, or IPv6). It MUST be one of the following values.<255>

Value

Meaning

PID_IPX

0x0000002B

IPX protocol

PID_IP

0x00000021

IPv4 protocol

PID_IPV6

0x00000057

IPv6 protocol

pInfoStruct: Specifies the pointer to a DIM_INTERFACE_CONTAINER (section 2.2.1.2.2).  

The fGetGlobalInfo member of the DIM_INTERFACE_CONTAINER MUST be set to 0.

The pGlobalInfo and dwGlobalInfoSize of DIM_INTERFACE_CONTAINER MUST be set. The rest of the fields SHOULD not be set.

The dwGlobalInfoSize field MUST be set to the size of the information passed in pGlobalInfo.

The pGlobalInfo member MUST point to a valid RTR_INFO_BLOCK_HEADER (section 2.2.1.2.3) and RTR_TOC_ENTRY (section 2.2.1.2.4). Otherwise, an error code is returned. The acceptable RTR_TOC_ENTRY values depend on the transport and the RRAS server implementation support; hence the RRAS server implementation SHOULD check that InfoType of RTR_TOC_ENTRY is supported.  

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

The opnum field value for this method is 9.

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 pInfoStruct is NULL, return an error other than one of the errors specified in the preceding table.

  • If dwTransportId is not specified in the SupportedTransportsList, return an error other than those specified in the preceding table.

  • If the dwGlobalInfoSize information in pInfoStruct is not the same as the Size field of RTR_INFO_BLOCK_HEADER, or if the RTR_INFO_BLOCK_HEADER is not constructed properly according to section 2.2.1.2.3, return an error other than one of the errors in the preceding table.

  • 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 value returned as a part of the RRAS server processing. Otherwise return ERROR_SUCCESS (0x00000000).

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