nn::cec::CTR::CecControl::StopScanning Member Function

Syntax

static nn::Result StopScanning(
     bool b_Immediate = false,
     bool b_Async = false
);

Arguments

Name Description
in b_Immediate When true is set, the saving of the data being transmitted is also cancelled and stopped.
in b_Async When true is set, returns immediately.

Return Values

nn::Result

Value Description
ResultSuccess Process succeeded.
ResultStateBusy Tried to halt but did not enter the idle state.
A value other than the above. Failed.

Description

Manually halts StreetPass (CEC) operations.

If communications are in progress, the communications are interrupted and changed to stop (IDLE) status.
To access a MessageBox, it must be in the stop state. The MessageBox::OpenMessageBox function runs StopScanning(b_Immediate = true). By using this function in advance, the daemon operation is not interrupted, and it can wait to enter the stop state.

When b_Async is set to true, there is a possibility that it will not enter stop status after exiting this function, such as when this function is called multiple times and cancels are issued.
Be aware that even if WriteMessage or similar functions are called after this function is called, an error might be generated because it is in the BUSY state.

Revision History

2010/08/16
Initial version.

CONFIDENTIAL