NWC24SetMsgSubject

C Specification

#include <revolution/nwc24.h>
NWC24Err NWC24SetMsgSubject( NWC24MsgObj* obj, const char* subject, u32 size );

Description

Specifies the message subject with a string.

The string provided here must use 7-bit coded characters only. When a Wii message is displayed on the Wii Message Board, the subject is ignored. When sending a string with UTF-16BE encoding, which is an internal character encoding, in a public message, use the NWC24SetMsgSubjectPublic function to perform character code conversion for the header and MIME encoding.

For reasons of internal processing, the data size that can be specified by size is limited to a maximum of 1,012 bytes.

The buffer given by the subject argument is not freed until NWC24CommitMsg() is called and creation of the message is complete.

Arguments

obj Pointer to the message object to be set.
subject Pointer to the subject string.
size Length of the string specified in subject.

Return Values

NWC24_OK: Normal termination.
NWC24_ERR_PROTECTED: Cannot change message object.
NWC24_ERR_NULL: The subject argument is a null pointer, or the subject title is empty.
NWC24_ERR_OVERFLOW: The value of size exceeds the size that can be processed.

See Also

NWC24InitMsgObj

Revision History

2007/07/18 Added text regarding size restrictions. Added NWC24_ERR_OVERFLOW to the return values and deleted NWC24_ERR_STRING_END.
2007/01/31 Added text about sending public messages.
2006/11/13 Added text about handling buffers.
2006/10/06 Updated the Return Values.
2006/08/01 Initial version.


CONFIDENTIAL