NWC24SetDlOptOutFlags

C Specification

#include <revolution/nwc24.h>

NWC24Err NWC24SetDlOptOutFlags( NWC24DlTask* taskPublic, u8 optFlags );

Description

Configures a task's Opt-Out settings.

A normal application does not need to use Opt-Out settings unless it has particular specifications.

These settings are used to collectively delete tasks when the user does not want to receive contents.

When enabling Opt-Out settings, set optFlags to the value defined by the NWC24_DL_OPTFLAG_OPT_OUT macro.

Arguments

`taskPublic`	Pointer to the download task.
`optFlags`	Flags for the Opt-Out settings.

Return Values

NWC24_OK: Ended normally.
NWC24_ERR_LIB_NOT_OPENED: The library has not been opened.
NWC24_ERR_PROTECTED: The download task is write-protected.
NWC24_ERR_INVALID_VALUE: The value of taskPublic is NULL, the download task is invalid, or the value of optFlags is invalid.

Revision History

2007/12/03 Added a note stating that normal applications does not need to use this function.
2007/08/06 Initial version.