Jump to main content

##

# TCPIP_STACK_NetMulticastSet Function

## C

    bool TCPIP_STACK_NetMulticastSet(
        TCPIP_NET_HANDLE netH
    );

## Description

This function sets the current default multicast network interface in the TCP/IP stack.

## Preconditions

The TCP/IP stack should have been initialized by TCPIP_STACK_Initialize() and the TCPIP_STACK_Status() returned SYS_STATUS_READY. The selected network interface should be up and running.

## Parameters

Parameters | Description
--- | ---
netH | Interface handle.

## Returns

- True - If successful.
- False - If failed (the old interface does not change).

## Remarks

At stack start up, the default multicast network is the same with the default network interface. This function allows the user to change it.