nn::cec::CTR::MessageBox::DeleteMessage Member Function

Syntax

nn::Result DeleteMessage(
     const CecBoxType boxType,
     const MessageId & messageId,
     bool withWriteBoxInfo
);

Arguments

Name Description
in boxType Inbox/outbox specification.
in messageId Specifies a MessageId.
in withWriteBoxInfo Updates to the internal message list are skipped when false is specified. The list is updated when the CommitMessageBox or CloseMessageBox function is called.

Return Values

nn::Result

Value Description
ResultSuccess Process succeeded.
ResultNotAuthorized The box has not been opened.
A value other than the above. Failed.

Description

Deletes a message.

Written data is committed when the CloseMessageBox or CommitMessageBox function is called after a modification has been made.

If you set withWriteBoxInfo equal to false, updates to the internal message list are skipped. This allows you to shorten the amount of time taken to delete multiple consecutive messages. Note that the GetMessageBoxXXX functions are unable to get accurate information if the list has not been updated.

Revision History

2010/08/16
Initial version.

CONFIDENTIAL