MessageBox - OpenGrok cross reference for /CTR-SDK-0.14.21/documents/api/nn/cec/CTR/MessageBox/

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta http-equiv="Content-Style-Type" content="text/css" />
    <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" />
<title>ReadMessage</title>
  </head>
  <body>
<h1><CODE>nn::cec::CTR::MessageBox::ReadMessage</CODE> Member Function</h1>
<h2>Syntax</h2>
    <div class="section">
      <pre class="definition">
<a href="../../../../nn/Result/Overview.html">nn::Result</a> ReadMessage(
     <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a> & cecMessage,
     void * buf,
     const size_t bufLen,
     const <a href="../../../../nn/cec/CTR/CecBoxType.html">CecBoxType</a> boxType,
     const <a href="../../../../nn/cec/CTR/MessageId/Overview.html">MessageId</a> & messageId
);
</pre>
    </div>
<h2>Arguments</h2>
    <div class="section">
      <table class="arguments">
        <thead>
          <tr>
            <td width="15" />
<th>Name</th>
<td>Description</td>
          </tr>
        </thead>
        <tr>
<td>out</td>
<th>cecMessage</th>
<td>Object of the <a href="../../../../nn/cec/CTR/Message/Overview.html"><CODE>Message</CODE></a> class where the data should be loaded.</td>
        </tr>
        <tr>
<td>out</td>
<th>buf</th>
<td>Buffer that stores a <a href="../../../../nn/cec/CTR/Message/Overview.html"><CODE>Message</CODE></a> binary array.</td>
        </tr>
        <tr>
<td>in</td>
<th>bufLen</th>
<td>Buffer size.</td>
        </tr>
        <tr>
<td>in</td>
<th>boxType</th>
<td>Inbox/outbox specification.</td>
        </tr>
        <tr>
<td>in</td>
<th>messageId</th>
<td>Specifies a <a href="../../../../nn/cec/CTR/MessageId/Overview.html"><CODE>MessageId</CODE></a>.</td>
        </tr> </table>
    </div>
<h2>Return Values</h2>
<div class="section"><a href="../../../../nn/Result/Overview.html">nn::Result</a><br /> <br />
      <table class="arguments">
        <thead>
          <tr>
<th>Value</th>
<td>Description</td>
          </tr>
        </thead>
        <tr>
<th><CODE>ResultSuccess</CODE></th>
<td>Process succeeded.</td>
        </tr>
        <tr>
<th><CODE>ResultStateBusy</CODE></th>
<td>Unable to access because the daemon is busy.</td>
        </tr>
        <tr>
<th><CODE>ResultNotAuthorized</CODE></th>
<td>The box has not been opened.</td>
        </tr>
        <tr>
<th><CODE>ResultInvalidArgument</CODE></th>
<td>Either an argument was specified incorrectly or the message is corrupted and cannot be read.</td>
        </tr>
        <tr>
<th>A value other than the above.</th>
<td>Failed.</td>
        </tr>
      </table> </div>
<h2>Description</h2>
    <div class="section">
<p>Reads a <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a>.</p>
    </div>
  <hr><p>CONFIDENTIAL</p></body>
</html>
Name		Date	Size	#Lines	LOC
..		-	-
CloseMessageBox.html	D	20-Nov-2018	1.5 KiB	29	29
CommitMessageBox.html	D	20-Nov-2018	2 KiB	51	51
CreateMessageBox(0).html	D	20-Nov-2018	7.5 KiB	151	151
CreateMessageBox(1).html	D	20-Nov-2018	5 KiB	127	127
CreateMessageBox.html	D	20-Nov-2018	4.4 KiB	62	61
DeleteAllMessages.html	D	20-Nov-2018	2 KiB	69	69
DeleteMessage(0).html	D	20-Nov-2018	2.7 KiB	75	75
DeleteMessage(1).html	D	20-Nov-2018	3.4 KiB	81	81
DeleteMessage.html	D	20-Nov-2018	2.8 KiB	47	46
DeleteMessageBox(0).html	D	20-Nov-2018	2.6 KiB	1	1
DeleteMessageBox(1).html	D	20-Nov-2018	2 KiB	58	58
DeleteMessageBox.html	D	20-Nov-2018	2.4 KiB	44	43
GetBoxActivate.html	D	20-Nov-2018	1.3 KiB	35	35
GetBoxFlag.html	D	20-Nov-2018	1.3 KiB	35	35
GetBoxGroupNum.html	D	20-Nov-2018	1.6 KiB	49	49
GetBoxGroupNumMax.html	D	20-Nov-2018	1.7 KiB	49	49
GetBoxMessNum.html	D	20-Nov-2018	1.6 KiB	49	49
GetBoxMessNumMax.html	D	20-Nov-2018	1.7 KiB	49	49
GetBoxSessionNum.html	D	20-Nov-2018	2.3 KiB	49	49
GetBoxSize.html	D	20-Nov-2018	1.5 KiB	49	49
GetBoxSizeMax.html	D	20-Nov-2018	1.6 KiB	49	49
GetInBoxMessIdByIndex.html	D	20-Nov-2018	1.6 KiB	49	49
GetMessIndex.html	D	20-Nov-2018	1.6 KiB	48	48
GetMessSizeByMessId.html	D	20-Nov-2018	2 KiB	61	61
GetMessageBodySize.html	D	20-Nov-2018	1.7 KiB	55	55
GetMessageBoxData.html	D	20-Nov-2018	2.3 KiB	77	77
GetMessageBoxDataSize.html	D	20-Nov-2018	1.6 KiB	49	49
GetMessageBoxIcon.html	D	20-Nov-2018	2.1 KiB	71	71
GetMessageBoxName.html	D	20-Nov-2018	2.2 KiB	71	71
GetMessageCreateDate.html	D	20-Nov-2018	1.8 KiB	55	55
GetMessageGroupId.html	D	20-Nov-2018	1.6 KiB	55	55
GetMessageMessId.html	D	20-Nov-2018	2.3 KiB	74	74
GetMessageMessIdPair.html	D	20-Nov-2018	2.6 KiB	73	73
GetMessageMessSize.html	D	20-Nov-2018	1.6 KiB	55	55
GetMessageMessTypeFlag.html	D	20-Nov-2018	1.8 KiB	55	55
GetMessagePropagationCount.html	D	20-Nov-2018	1.7 KiB	55	55
GetMessageRecvDate.html	D	20-Nov-2018	1.8 KiB	55	55
GetMessageSendCount.html	D	20-Nov-2018	1.6 KiB	55	55
GetMessageSendDate.html	D	20-Nov-2018	1.8 KiB	55	55
GetMessageSendMode.html	D	20-Nov-2018	1.8 KiB	55	55
GetMessageSessionId.html	D	20-Nov-2018	1.7 KiB	55	55
GetMessageTag.html	D	20-Nov-2018	1.6 KiB	55	55
GetOutBoxMessIdByIndex.html	D	20-Nov-2018	1.7 KiB	49	49
IsOpened.html	D	20-Nov-2018	1.3 KiB	35	35
OpenMessageBox.html	D	20-Nov-2018	4.7 KiB	1	1
Overview.html	D	20-Nov-2018	21.5 KiB	426	385
ReadMessage.html	D	20-Nov-2018	3 KiB	94	94
RoundOutBoxIndex.html	D	20-Nov-2018	1.8 KiB	49	49
SetBoxActivate.html	D	20-Nov-2018	2.1 KiB	69	69
SetBoxGroupNumMax.html	D	20-Nov-2018	3 KiB	79	79
SetMessageBoxData.html	D	20-Nov-2018	2.5 KiB	85	85
SetMessageBoxIcon.html	D	20-Nov-2018	2.7 KiB	75	75
SetMessageBoxName.html	D	20-Nov-2018	2.5 KiB	79	79
WriteMessage(0).html	D	20-Nov-2018	4.4 KiB	105	105
WriteMessage(1).html	D	20-Nov-2018	7.8 KiB	1	1
WriteMessage.html	D	20-Nov-2018	6.7 KiB	1	1