Jump to main content

##

# TCPIP_ANNOUNCE_MessageRequest Function

## C

    bool TCPIP_ANNOUNCE_MessageRequest(
    TCPIP_NET_HANDLE hNet,
    TCPIP_ANNOUNCE_BROADCAST_TYPE bcastType
    );

## Description

This function instructs the module to send an announce message on the specified interface using the selected broadcast type. If successful, the message is triggered and will be sent to the output.

## Preconditions

The Announce module should have been initialized.

## Parameters

Parameters | Description
--- | ---
hNet | handle of the network to send announce message. If 0, the announce message will be sent on all interfaces.
bcastType | type of broadcast to be used. This type becomes the current broadcast type. If == TCPIP_ANNOUNCE_BCAST_NONE, the broadcast type is not changed.

## Returns

- true - if the selected network is valid and the announce message is initiated.
- false - if no such network, or network is down.

## Remarks

The sending of the message does not occur in the context of this function. This function just initiates an announce message request.