nn::uds::CTR::DisconnectNetwork Function

Syntax

nn::Result DisconnectNetwork(
     void
);

Arguments

None.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Destroyed the network and transitioned to the STATE_DISCONNECTED state.
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

Disconnects a given node from the network to which it is currently connected.

Only clients and spectators can run this function. Considers the disconnected state (being disconnected from the network for external reasons), and succeeds even when not connected to the network.
This function is thread-safe.

Revision History

2011/09/07
Standardized notation for wireless-disabled mode.
2011/03/08
Added a link to Initialize in Return Values.
2010/06/14
Initial version.

CONFIDENTIAL