Jump to main content

##

# TCPIP_STACK_NetBiosNameSet Function

## C

    bool TCPIP_STACK_NetBiosNameSet(
        TCPIP_NET_HANDLE netH,
        const char* biosName
    );

## Description

This function sets the network interface NetBIOS name.

## Preconditions

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

## Parameters

Parameters | Description
--- | ---
netH | Interface handle to set name of.

## Returns

- True - If the NetBIOS name of the interface is set.
- False - If no such interface or interface is not enabled.

## Remarks

Exercise extreme caution when using these functions to change the settings of a running network interface. Changing these parameters at runtime can lead to unexpected behavior or loss of network connectivity. The preferred way to change the parameters for a running interface is to do so as part of the network configuration passed at the stack initialization.

## Example

    TCPIP_NET_HANDLE netH = TCPIP_STACK_NetHandleGet("PIC32INT");
    TCPIP_STACK_NetBiosNameSet(netH, myBiosName);