NWC24 Library Function List

Common

NWC24OpenLib Initializes the library.
NWC24CloseLib Terminates execution of the message line of functions started by NWC24OpenLib() and resumes the automatic send/receive function.
NWC24GetMyUserId Gets the WiiConnect24 user ID currently assigned to the Wii console.
NWC24CheckUserId Checks whether the specified user ID (the Wii number) is valid.
NWC24Check Checks the operational status of the WiiConnect24 system.
NWC24IsNewMsgArrived Returns whether any new messages have arrived since the last time NWC24OpenLib() or NWC24CloseLib() were called.
NWC24GetErrorCode Returns a WiiConnect24 system error code (a 6-digit numeric value).
NWC24EnableLedNotification Permits or prohibits LED illumination when a WiiConnect24 message arrives.

Messages

NWC24InitMsgObj Initializes message objects used to create new messages.
NWC24SetMsgToId Specifies the recipient of the message with a user ID.
NWC24SetMsgToAddr Specifies the recipient of the message with a character string.
NWC24SetMsgSubject Specifies the message subject with a string.
NWC24SetMsgSubjectPublic Specifies the public message subject with a string.
NWC24SetMsgText Specifies the body text of the message with a character string.
NWC24SetMsgTextPublic Specifies the body text of the public message as a string.
NWC24SetMsgSubjectAndTextPublic Specifies the public message subject and body text with strings.
NWC24SetMsgAttached Attaches binary data to the message.
NWC24SetMsgTag Sets a tag to a message.
NWC24SetMsgDesignatedTime Specifies a message's scheduled send time.
NWC24SetMsgLedPattern Sets the LED illumination specification for when messages are received.
NWC24SetMsgIconNewSign Specifies a new arrival display with a channel icon to a message.
NWC24GetMsgType Returns a message object setting (message type).
NWC24GetMsgFromId Returns a message object setting (message sender ID).
NWC24GetMsgNumTo Returns a message object setting (number of message recipients).
NWC24GetMsgSubjectSize Returns a message object setting (number of bytes in the message's subject string).
NWC24GetMsgTextSize Returns a message object setting (number of bytes in the body of the message).
NWC24GetMsgTextPtr Returns a message object setting (a pointer to the text source data of the message).
NWC24GetMsgNumAttached Returns a message object setting (number of binary attachments).
NWC24GetMsgAttachedSize Returns a message object setting (number of bytes of attached binary data).
NWC24GetMsgAttachedType Returns a message object setting (type of attached binary files).
NWC24GetMsgAttachedPtr Returns a message object setting (a pointer to the attached binary source data).
NWC24GetMsgDate Returns a message object setting (the date and time created).
NWC24GetMsgTag Returns a message object setting (the tag information).
NWC24GetMsgId Returns a message object setting (the message ID).
NWC24GetMsgAppId Returns a message object setting (sender application ID).
NWC24GetMsgGroupId Returns the message object settings (the sender's group ID).
NWC24GetMsgSize Returns the total size of the message.
NWC24ReadMsgFromAddr Reads the character string representing the address of the sender of the message from message data.
NWC24ReadMsgToId Reads one of the message recipient IDs from message data.
NWC24ReadMsgToAddr Reads one of the message's recipient addresses from message data.
NWC24ReadMsgSubject Reads the subject of the message from message data.
NWC24ReadMsgSubjectPublic Reads the string data representing the subject portion of a public message from the message data.
NWC24ReadMsgText Reads the string data of the body text portion of a message from the message data.
NWC24ReadMsgTextEx Reads the string data of the body text portion of a message from the message data.
NWC24ReadMsgTextPublic Reads the string data of the body text portion of a public message from the message data.
NWC24ReadMsgAttached Reads the binary data attached to the message from message data.
NWC24CommitMsg Creates message data based on the contents of the message object for which all settings have been set and stores the message data in the outbox.
NWC24GetNumMsgs Returns the total number of messages held in the specified message box (outbox or inbox).
NWC24GetMsgIdList Returns a list of message IDs held in the specified message box (outbox or inbox).
NWC24GetMsgObj Gets the meta-information about the message with the specified ID in the specified message box and expands that information into an NWC24MsgObj object.
NWC24DeleteMsg Deletes the message with the specified ID from the specified message box.
NWC24CheckMsgBoxSpace Determines whether there is space enough to store the message in the specified message box.

Friend Roster

NWC24ReadFriendInfo Gets the information on the console friend roster.
NWC24WriteFriendInfo Stores information to the console friend roster.
NWC24UpdateFriendInfo Updates the information on the console friend roster.
NWC24DeleteFriendInfo Deletes the information on the console friend roster.
NWC24SwapFriendInfos Swaps information on the console friend list.
NWC24SearchFriendInfoById Searches for the index number under which friend information, including the specified Wii ID, is registered within the console friend roster.
NWC24SearchFriendInfoByAddr Searches for the index number under which the friend information that includes the specified e-mail address is registered in the Wii Friend Roster.
NWC24IsFriendInfoThere Checks whether information is registered in the specified location in the console friend roster.
NWC24GetFriendInfoStatus Performs a simple check of the registration status of the specified position in the console friend list.
NWC24GetNumFriendInfos Returns the total number that can be registered in the console friend roster.
NWC24GetNumRegFriendInfos Returns the total number registered in the console friend roster.
NWC24GetNumEstFriendInfos Returns the total number of friends registered on the Wii Friend Roster with whom friendships have already been established and confirmed.
NWC24CheckFriendInfo Checks the validity of friend information.
NWC24CheckPublicMailAddr Checks the validity of an e-mail address.

Wii Message Board

NWC24IsNewMsgForMenuArrived Returns whether a message for the Wii Message Board has arrived since the application started.
NWC24SetMsgAltName Sets an alternate nickname for the message sender.
NWC24SetMsgMBNoReply Turns off the reply from user feature when messages are handled by the Wii Message Board.
NWC24SetMsgMBRegDate Specifies the date when registering on the Wii Message Board calendar.
NWC24SetMsgMBDelay Specifies the amount of time to delay after a message is registered on the Wii Message Board before displaying to the user.
NWC24ReadMsgAltName Reads the alternate nickname of the sender set for the message.
NWC24ReadMsgMBNoReply Reads Wii Message Board setting of a message (reply OFF flag from the user).
NWC24ReadMsgMBRegDate Reads the calendar date set for messages on the Wii Message Board (date registered on the message board).
NWC24ReadMsgMBDelay Reads Wii Message Board setting of a message (period of time the message is not displayed).

Message Search

NWC24InitSearchConds Initializes the search process and clears all conditions.
NWC24SetSearchCondMsgBox Specifies the message box targeted for the message search.
NWC24SetSearchCondForMenu Specifies only messages with the flag for displaying on the console menu enabled as the message search condition.
NWC24SetSearchCondPublic Specifies whether to include Public messages in the targeted message search.
NWC24SetSearchCondFromAddrId Specifies the message search conditions (Wii number of the sender).
NWC24SetSearchCondAppId Specifies the message search condition (application ID).
NWC24SetSearchCondTag Specifies the message search condition (tag ID).
NWC24SearchMsgs Performs the message search and stores the obtained results in an array.

Scheduler Operation

NWC24SuspendScheduler Temporarily halts the scheduler. Blocks and waits until it stops.
NWC24TrySuspendScheduler Tries to temporarily halt the automatic scheduler. Does not block.
NWC24ResumeScheduler Releases the temporary halt of the automatic scheduler.
NWC24GetSchedulerError Gets the error code (6-digit negative value) generated by the automatic scheduler process.
NWC24GetScheduleSpan Gets the processing interval (in minutes) of the automatic scheduler.
NWC24ExecDownloadTask Immediately activates the download process.

Downloads

NWC24InitDlTask Initializes a download task.
NWC24AddDlTask Adds a download task to the task list.
NWC24CheckDlTask Checks whether the download task has a valid value.
NWC24UpdateDlTask Updates the task list with the reconfigured download task.
NWC24DeleteDlTask Deletes a download task.
NWC24DeleteDlTasksForOptOut Deletes download tasks whose Opt-Out flags are set.
NWC24GetDlTask Gets the download task with the specified ID.
NWC24GetDlTaskMine Gets the download task that was previously registered by the application currently running.
NWC24GetDlTaskIdByAppId Gets the ID of download tasks owned by an application specified with the application ID.
NWC24GetDlTaskByAppId Gets download tasks owned by an application specified with the application ID.
NWC24EnableDlLaxParameterChecking Sets whether to loosen restrictions on some function parameters for debugging.
NWC24GetDlHomeDir Gets the home directory path of the application that registered the download task.
NWC24CreateDlVf Creates a VF archive for file storage.
NWC24GetDlVfPath Gets the path of the VF archive file for the download box in the Home directory.
NWC24GetDlVfPathByTask Gets the VF archive file path where the specified download task stores files.
NWC24SetDlKeys Specifies the RSA public key that the application will use for signature verification as well as the AES shared key for decryption.
NWC24ClearDlKeys Deletes the keys that are set for an application.
NWC24ClearDlError Clears the error history information recorded in a download task.
NWC24DumpDlTask Displays the content of a download task to standard output.
NWC24GetNumDlTasks Gets the maximum number of download tasks that can be registered.
NWC24GetNumRegDlTasks Gets the total number of registered download tasks.
NWC24GetDlId Gets the download task ID.
NWC24GetDlType Gets a download task's type.
NWC24GetDlPriority Gets the priority of the download task.
NWC24GetDlInterval Gets the update check interval for the download task.
NWC24GetDlServerInterval Gets the server-side content update interval.
NWC24GetDlRetryMargin Gets the length of time by which the expected download time may be exceeded.
NWC24GetDlUrl Gets the URL for the download task.
NWC24GetDlCount Gets the remaining download count.
NWC24GetDlNextTime Gets the next scheduled execution time of the download task.
NWC24GetDlLastUpdate Gets the last updated time of the downloaded content.
NWC24GetDlFilename Gets the save file name for the downloaded file.
NWC24GetDlFlags Gets the flags for the download task.
NWC24GetDlAppId Gets ID of the application that created a download task.
NWC24GetDlOptOutFlags Gets a task's Opt-Out settings.
NWC24GetDlRootCA Gets ID of the Root CA that was set for a download task.
NWC24GetDlError Obtains the most recently generated error code and the error generation count from a download task's error history information.
NWC24SetDlPriority Sets the priority of the download task.
NWC24SetDlInterval Sets the update check interval for the download task.
NWC24SetDlServerInterval Sets the server-side content update interval for the download task.
NWC24SetDlRetryMargin Sets the length of time by which the expected download time may be exceeded.
NWC24SetDlUrl Sets the URL for the download task.
NWC24SetDlCount Sets the remaining download count.
NWC24SetDlOptOutFlags Configures a task's Opt-Out settings.
NWC24SetDlRootCA Sets ID of the Root CA for a download task.
NWC24SetDlParameter Sets an optional parameter value that can be used to identify the task.
NWC24GetDlParameter Gets the parameter value that was set to identify the task.
NWC24SetDlFilename Sets the file name when saving the downloaded file to VF.
NWC24SetDlFlags Sets the flags for the download task.
NWC24IterateDlTask Iterates through all the download tasks.
NWC24InitDlIterateContext Initializes the context for NWC24IterateDlTaskEx().
NWC24IterateDlTaskEx Iterates through the valid tasks in the specified order.

Types and Structures

NWC24MsgType Enumerated type to indicate the message type.
NWC24MsgBoxId Enumerated type to indicate the mailbox type.
NWC24Charset Enumerated type to indicate the charset type.
NWC24Encoding Enumerated type to indicate the MIME encoding type.
NWC24MIMEType Enumerated type to indicate the MIME-encoded attached file type.
NWC24AutoEncodingType A hint value used for automatic encoding detection.
NWC24UserId A type for storing WiiConnect24 user IDs.
NWC24MsgObj A structure for storing WiiConnect24 message objects.
NWC24Err An enumerated type indicating the types of errors that can occur when running NWC24 functions.
NWC24FriendAttr A structure that indicates the attributes (status, nickname, and so on) of the registered friend.
NWC24FriendAddr A structure that indicates different information depending on the type of address registered.
NWC24FriendInfo A structure that indicates the registration information for one entry in the console's friend roster.
NWC24DlTask A structure for storing WiiConnect24 download tasks.
NWC24DlType An enumerated type indicating the type of download task.
NWC24DlIterateContext A structure for iterating through download tasks.
NWC24DlIterateOperation An enumerated type indicating the iteration order for the download tasks.
NWC24SearchCompareMode An enumerated type used to specify value comparison conditions for the message search functions.

CONFIDENTIAL