3.5.4.4.2 GetIcsEnabled Method (Opnum 4)

  • Article

The GetIcsEnabled method retrieves the status of whether the "Network Address Translation (NAT)" or "Internet Connection Sharing" feature is enabled on RRAS. 

 HRESULT GetIcsEnabled([out] BOOL * status);

Status: A pointer to a BOOL. The value of the method is either TRUE or FALSE.  If TRUE, indicates that NAT is enabled on the server on at least one connection. If FALSE, indicates that NAT is not enabled on any connection on the server.

Return Values: The server MUST return zero if it successfully processes the message. If processing fails, the server MUST return a nonzero HRESULT error code as defined in the [MS-DTYP] section 2.2.18, between 0x80000000 and 0xFFFFFFFF, as specified in [MS-ERREF] section 2.1. All nonzero values MUST be treated as equivalent failures.

When processing this call, the RRASM server MUST do the following:

  • Call the abstract interface Invoke REMRAS method (section 3.5.6.1) specifying the operation and the parameters to enable the RRAS server to perform the required management task.

  • Return any error status the RRAS server returns. Otherwise return ERROR_SUCCESS.

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