nn::cec::CTR::MessageBoxInfoReader Classclass MessageBoxInfoReader
Gets the header information for a box's message. It can be used in cases such as when getting a list of messages.
It cannot be used to read the body of a message or an extended header (containing icons, for example). You must use the Message class to read such data.
The features of this class have been integrated into the MessageBox class. This class is scheduled to be removed from the library.
| Initialization | ||
|---|---|---|
| MessageBoxInfoReader | Constructor. This loads box information for the specified MessageBox object. The specified message box must be open. |
|
| LoadMessageBoxInfo | Loads the box information by specifying the MessageBox object. The specified message box must be open. |
|
| Getting Message Box Information | ||
| GetMessageBoxInfoFlag | Gets a MessageBoxFlag. |
|
GetBoxSizeMax
|
Gets the maximum box capacity. | |
GetBoxSize
|
Gets the box capacity being used. | |
| GetMessNumMax | Gets the maximum number of messages a box can contain. | |
| GetMessNum | Gets the number of messages in a box. | |
| Getting Message Information | ||
GetMessageMessSize
|
Gets the size of a message. | |
GetMessageBodySize
|
Gets the size of a message's body. | |
GetMessageGroupId
|
Gets the group ID of a message. | |
GetMessageSessionId
|
Gets an inbox message's session ID. (The ID assigned when received.) | |
GetMessageMessTypeFlag
|
Gets the CecMessageTypeFlag of a message. |
|
GetMessageSendMode
|
Gets the SendMode of a message. |
|
GetMessageSendCount
|
Gets the send count of a message. | |
GetMessagePropagationCount
|
Gets the propagation count of a message. | |
| GetMessageFlag_Unread | Gets the unread flag of a message. | |
| GetMessageFlag_New | Gets the new arrival flag of a message. | |
GetMessageTag
|
Gets the message tag of a message. | |
GetMessageSendDate
|
Gets the timestamp of when a received message was sent. | |
GetMessageRecvDate
|
Gets the timestamp of when a message was received. | |
GetMessageCreateDate
|
Gets the timestamp of when a message was created. | |
GetMessageMessIdPair
|
Gets the pair of MessageIDs corresponding to a message exchange. |
|
GetMessageMessId
|
Gets the MessageID of a message. |
|
GetMessIndex
|
Gets a message's index (messIndex) based on its MessageID. |
|
CONFIDENTIAL