nn::uds::CTR::EjectSpectator Function

Syntax

nn::Result EjectSpectator(
     void
);

Arguments

None.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
ResultSuccess Process was successful.
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 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.

Revision History

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.

CONFIDENTIAL