MessageBox - OpenGrok cross reference for /CTR-SDK-0.13.2/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"><CODE>nn::Result</CODE></a> </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
..		-	-
CreateMessageBox(0).html	D	20-Nov-2018	5.9 KiB	115	115
CreateMessageBox(1).html	D	20-Nov-2018	4.3 KiB	91	91
CreateMessageBox.html	D	20-Nov-2018	4 KiB	62	61
DeleteMessage.html	D	20-Nov-2018	1.9 KiB	55	55
DeleteMessageBox(0).html	D	20-Nov-2018	1.7 KiB	27	27
DeleteMessageBox(1).html	D	20-Nov-2018	1.7 KiB	42	42
DeleteMessageBox.html	D	20-Nov-2018	2.7 KiB	44	43
GetBoxActivate.html	D	20-Nov-2018	1.3 KiB	36	35
GetBoxFlag.html	D	20-Nov-2018	1.2 KiB	28	28
GetBoxGroupNum.html	D	20-Nov-2018	1.6 KiB	50	49
GetBoxGroupNumMax.html	D	20-Nov-2018	1.7 KiB	49	49
GetBoxMessNum.html	D	20-Nov-2018	1.6 KiB	50	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	50	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.7 KiB	48	48
GetMessSizeByMessId.html	D	20-Nov-2018	2 KiB	61	61
GetMessageBodySize.html	D	20-Nov-2018	1.6 KiB	48	48
GetMessageBoxData.html	D	20-Nov-2018	2 KiB	61	61
GetMessageBoxDataSize.html	D	20-Nov-2018	1.6 KiB	49	49
GetMessageBoxIcon.html	D	20-Nov-2018	1.7 KiB	48	48
GetMessageBoxName.html	D	20-Nov-2018	1.8 KiB	48	48
GetMessageCreateDate.html	D	20-Nov-2018	1.8 KiB	48	48
GetMessageGroupId.html	D	20-Nov-2018	1.6 KiB	48	48
GetMessageMessId.html	D	20-Nov-2018	2 KiB	54	54
GetMessageMessIdPair.html	D	20-Nov-2018	2.3 KiB	53	53
GetMessageMessSize.html	D	20-Nov-2018	1.6 KiB	48	48
GetMessageMessTypeFlag.html	D	20-Nov-2018	1.7 KiB	48	48
GetMessagePropagationCount.html	D	20-Nov-2018	1.6 KiB	48	48
GetMessageRecvDate.html	D	20-Nov-2018	1.8 KiB	48	48
GetMessageSendCount.html	D	20-Nov-2018	1.6 KiB	48	48
GetMessageSendDate.html	D	20-Nov-2018	1.8 KiB	48	48
GetMessageSendMode.html	D	20-Nov-2018	1.7 KiB	48	48
GetMessageSessionId.html	D	20-Nov-2018	1.6 KiB	48	48
GetMessageTag.html	D	20-Nov-2018	1.6 KiB	48	48
GetOutBoxMessIdByIndex.html	D	20-Nov-2018	1.7 KiB	49	49
OpenMessageBox.html	D	20-Nov-2018	2.1 KiB	55	55
Overview.html	D	20-Nov-2018	16.5 KiB	398	357
ReadMessage.html	D	20-Nov-2018	2.3 KiB	66	66
RoundOutBoxIndex.html	D	20-Nov-2018	1.8 KiB	49	49
SetBoxActivate.html	D	20-Nov-2018	1.7 KiB	50	49
SetBoxGroupNumMax.html	D	20-Nov-2018	2.3 KiB	56	55
SetMessageBoxData.html	D	20-Nov-2018	2 KiB	61	61
SetMessageBoxIcon.html	D	20-Nov-2018	1.7 KiB	48	48
SetMessageBoxName.html	D	20-Nov-2018	1.8 KiB	48	48
WriteMessage.html	D	20-Nov-2018	2.2 KiB	53	53