nn::uds::CTR::EjectSpectator Function

nn::Result EjectSpectator(
     void
);

None.

Returns the function's execution result. Returns one of the Result values listed below.

Value	Description
Result::IsSuccess	Process was successful.
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.

Kicks all the connected spectators off of the network.

New spectators will be unable to connect after you execute this function. To allow Spectator nodes to connect again, call the AllowToSpectate function. Only the master can run this function.

This function is thread-safe.

2011/09/07

Standardized notation for wireless-disabled mode.

2011/03/08

Added a link to Initialize in Return Values.

2010/10/15

Expanded the information on the return values. Revised the Description to make it easier to understand.

2010/09/17

In the past, the signal strength sometimes made it impossible to eject Spectator nodes. The specifications were changed so that Spectator nodes are prevented from connecting after this function is run, thereby eliminating Spectator nodes from the network.

2010/08/16

Initial version.