SCFlush*

C Specification

#include <revolution/sc.h>

typedef void (*SCFlushCallback)(u32 result);

u32  SCFlush(void);
void SCFlushAsync(SCFlushCallback callback);

Arguments

There are no arguments for SCFlush().

The arguments for SCFlushAsync() are shown below.

callback Callback function called when processing ends. No callback function is called if NULL is specified.

Return Values

One of the SC_STATUS_* values is returned for SCFlush().

There are no return values for SCFlushAsync().

Description

Console settings maintained in RAM are reflected in internal flash memory. After console settings change, be sure to call SCFlush() or SCFlushAsync().

SCFlush() does not return until processing to reflect settings has completed. Therefore, do not call SCFlush() from the interrupt handler or a callback.

SCFlushAsync() executes processing to reflect settings in the background. The callback function specified by the argument callback is called whether SCFlushAsync() succeeds or fails. No callback function is called if NULL is specified.

Flash memory is not accessed if there are no changes to console settings maintained in RAM.

When more than one setting is changed in the same cycle, you only need to SCFlush*() once at the end.

The return value of SCFlush() has the same meaning as the argument result of the SCFlushAsync() callback function, as follows.

Return Values and Arguments	Results
`SC_STATUS_OK`	Processing succeeded.
`SC_STATUS_ERROR`	Processing failed.

The return value of SCCheckStatus() is updated regardless of which function was called.

Revision History