nn::uds::CTR::EjectClient Function

Syntax

nn::Result EjectClient(
     u16 nodeId
);

Parameters

Name Description
in nodeId ID of node to eject. If BROADCAST_NODE_ID is specified, all connected nodes will be ejected.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess The target node was removed from the network.
ResultNotInitialized The library is not initialized. Execute the Initialize function.
ResultInvalidState Not in an executable state. Returned when executed in a state other than master.
ResultWirelessOff Entered wireless-disabled mode. Re-initialization is required.
A value other than the above Failed for reasons other than those given above.

Description

Kicks the specified node off of the network. Only the master can run this function.

This function is thread-safe.

Revision History

2011/09/07
Standardized notation for wireless-disabled mode.
2011/03/08
Added a link to the BROADCAST_NODE_ID argument. Added a link to Initialize in Return Values.
2010/10/15
Expanded the information on the return values.
2010/06/14
Initial version.

CONFIDENTIAL