nn::uds::CTR::EjectClient Function

Syntax

nn::Result EjectClient(
     u16 nodeId
);

Arguments

Name Description
in nodeId Node ID to disconnect. Specify BROADCAST_NODE_ID to kick all connected clients.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
ResultSuccess The target client was removed from the network.
ResultNotInitialized The library is not initialized. Execute the nn::uds::Initialize function.
ResultInvalidState Not in an executable state. Returned when executed in a state other than master.
ResultWirelessOff Transitioned to wireless OFF 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.

Revision History

2010/10/15
Expanded the information on the return values.
2010/06/14
Initial version.

CONFIDENTIAL