1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2<html><head> 3<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/> 4<meta name="keywords" content="LLDB,C++,doxygen,API,documentation"/> 5<meta name="description" content="C++ source code API documentation for LLDB."/> 6<title>LLVM: SBCommandReturnObject.h Source File</title> 7<link href="doxygen.css" rel="stylesheet" type="text/css"/> 8</head><body> 9<p class="title">LLDB API Documentation</p> 10<!-- Generated by Doxygen 1.8.1.2 --> 11 <div id="navrow1" class="tabs"> 12 <ul class="tablist"> 13 <li><a href="index.html"><span>Main Page</span></a></li> 14 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 15 <li><a href="annotated.html"><span>Classes</span></a></li> 16 <li class="current"><a href="files.html"><span>Files</span></a></li> 17 </ul> 18 </div> 19 <div id="navrow2" class="tabs2"> 20 <ul class="tablist"> 21 <li><a href="files.html"><span>File List</span></a></li> 22 </ul> 23 </div> 24<div id="nav-path" class="navpath"> 25 <ul> 26<li class="navelem"><a class="el" href="dir_217b186c19a2bb8bc0ee0f71fb72d4e8.html">tools</a></li><li class="navelem"><a class="el" href="dir_fa64c3fa8a988674a1a867b97ca9a790.html">lldb</a></li><li class="navelem"><a class="el" href="dir_9d4b8469db156c557ab1d649b027ec2e.html">include</a></li><li class="navelem"><a class="el" href="dir_c02e3ff158c3064d7b78c6aa6fc411e6.html">lldb</a></li><li class="navelem"><a class="el" href="dir_36ad4ea5df2b352cce0512435d34c8a4.html">API</a></li> </ul> 27</div> 28</div><!-- top --> 29<div class="header"> 30 <div class="headertitle"> 31<div class="title">SBCommandReturnObject.h</div> </div> 32</div><!--header--> 33<div class="contents"> 34<a href="SBCommandReturnObject_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//===-- SBCommandReturnObject.h ---------------------------------*- C++ -*-===//</span></div> 35<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div> 36<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// The LLVM Compiler Infrastructure</span></div> 37<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div> 38<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// This file is distributed under the University of Illinois Open Source</span></div> 39<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// License. See LICENSE.TXT for details.</span></div> 40<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div> 41<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//===----------------------------------------------------------------------===//</span></div> 42<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div> 43<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef LLDB_SBCommandReturnObject_h_</span></div> 44<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span><span class="preprocessor">#define LLDB_SBCommandReturnObject_h_</span></div> 45<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span></div> 46<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <stdio.h></span></div> 47<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div> 48<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "<a class="code" href="SBDefines_8h.html">lldb/API/SBDefines.h</a>"</span></div> 49<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> 50<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span>lldb {</div> 51<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> 52<div class="line"><a name="l00019"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCommandReturnObject.html"> 19</a></span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBCommandReturnObject.html">SBCommandReturnObject</a></div> 53<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> {</div> 54<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">public</span>:</div> 55<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> 56<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#aa3d13159daa9d43ec14a84bae63fa9d1">SBCommandReturnObject</a> ();</div> 57<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> 58<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#aa3d13159daa9d43ec14a84bae63fa9d1">SBCommandReturnObject</a> (<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCommandReturnObject.html">lldb::SBCommandReturnObject</a> &rhs);</div> 59<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> 60<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCommandReturnObject.html">lldb::SBCommandReturnObject</a> &</div> 61<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a574d6b4790840fbac8f3dc400a9a13bb">operator = </a>(<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCommandReturnObject.html">lldb::SBCommandReturnObject</a> &rhs);</div> 62<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div> 63<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> 64<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#aa3d13159daa9d43ec14a84bae63fa9d1">SBCommandReturnObject</a> (lldb_private::CommandReturnObject *ptr);</div> 65<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> 66<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  lldb_private::CommandReturnObject *</div> 67<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#aa95b4bf0db28c9685b9742a0308d3b8a">Release</a> ();</div> 68<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> 69<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a4a55f883fca2f67e89f7653879d3e778">~SBCommandReturnObject</a> ();</div> 70<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> 71<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">bool</span></div> 72<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a3e5536ff178dba1ccec57c1bcc54a15e">IsValid</a>() <span class="keyword">const</span>;</div> 73<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> 74<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *</div> 75<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a703545c804277b76dd6f74d2f32c9638">GetOutput</a> ();</div> 76<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> 77<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *</div> 78<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a361c705b3f90584c9d51ca4842f22cb1">GetError</a> ();</div> 79<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div> 80<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">size_t</span></div> 81<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a3b3248ace199baf7ca97a7bf8e272203">PutOutput</a> (FILE *fh);</div> 82<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> 83<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">size_t</span></div> 84<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#afaf8d191cbc31b53a2d140899cb0dd58">GetOutputSize</a> ();</div> 85<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> 86<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">size_t</span></div> 87<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#adc20bb52e23839df794fc10ab3daef83">GetErrorSize</a> ();</div> 88<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> 89<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">size_t</span></div> 90<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a95ba2d9d2a5e272f5deeeac68ffd8aa8">PutError</a> (FILE *fh);</div> 91<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> 92<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span></div> 93<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a6160e57236fb9f46fc9d63ef2adedc40">Clear</a>();</div> 94<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> 95<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  lldb::ReturnStatus</div> 96<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#ab761c889072b350610b8e888b1ea7cac">GetStatus</a>();</div> 97<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div> 98<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span></div> 99<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a8b45554a7921936648ecba7e00520e73">SetStatus</a> (lldb::ReturnStatus status);</div> 100<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> 101<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">bool</span></div> 102<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a6784d9124a2fe55b7d4d67ecd3609f35">Succeeded</a> ();</div> 103<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> 104<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">bool</span></div> 105<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a7b41bae7e6629d6fe83c9075607f0b17">HasResult</a> ();</div> 106<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div> 107<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">void</span></div> 108<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a5c4253d94de92c0d1e49cf6cc4ed74a1">AppendMessage</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *message);</div> 109<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div> 110<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">void</span></div> 111<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a49d186dd9481e70e5d135e7c81d99049">AppendWarning</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *message);</div> 112<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div> 113<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">bool</span></div> 114<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a5e19eace0e45d7587cfb9ed13dd348ef">GetDescription</a> (<a class="code" href="classlldb_1_1SBStream.html">lldb::SBStream</a> &description);</div> 115<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div> 116<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">void</span></div> 117<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a48a93a1df3f32f10f2216ec8038c9b54">SetImmediateOutputFile</a> (FILE *fh);</div> 118<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div> 119<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">void</span></div> 120<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#ace1d97e07b8daa62bdbdd345f1a3e53c">SetImmediateErrorFile</a> (FILE *fh);</div> 121<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div> 122<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">void</span></div> 123<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a2f17cb9d70daaf9dfb3ccc881228c52e">PutCString</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keywordtype">string</span>, <span class="keywordtype">int</span> len = -1);</div> 124<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div> 125<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">size_t</span></div> 126<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#aeadb27b5b35c33ceb8d8b77dccc7e979">Printf</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* format, ...) __attribute__ ((format (printf, 2, 3)));</div> 127<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  </div> 128<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *</div> 129<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a703545c804277b76dd6f74d2f32c9638">GetOutput</a> (<span class="keywordtype">bool</span> only_if_no_immediate);</div> 130<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div> 131<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *</div> 132<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a361c705b3f90584c9d51ca4842f22cb1">GetError</a> (<span class="keywordtype">bool</span> only_if_no_immediate);</div> 133<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div> 134<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">void</span></div> 135<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a84b2f3b1aa9f6290947e2f5f799d4d0f">SetError</a> (<a class="code" href="classlldb_1_1SBError.html">lldb::SBError</a> &error,</div> 136<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *fallback_error_cstr = NULL);</div> 137<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  </div> 138<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">void</span></div> 139<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a84b2f3b1aa9f6290947e2f5f799d4d0f">SetError</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* error_cstr);</div> 140<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div> 141<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">protected</span>:</div> 142<div class="line"><a name="l00109"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCommandReturnObject.html#af3fb6efd0d4f3b3bb7b87db062eb48c9"> 109</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBCommandInterpreter.html">SBCommandInterpreter</a>;</div> 143<div class="line"><a name="l00110"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCommandReturnObject.html#aee9a0d1e363dceb8bc8ae91580177403"> 110</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBCommandReturnObject.html#aee9a0d1e363dceb8bc8ae91580177403">SBOptions</a>;</div> 144<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> 145<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  lldb_private::CommandReturnObject *</div> 146<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a1dd1f14531c7ee856a335b6243fc3c61">operator-></a>() <span class="keyword">const</span>;</div> 147<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div> 148<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  lldb_private::CommandReturnObject *</div> 149<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">get</span>() <span class="keyword">const</span>;</div> 150<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div> 151<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  lldb_private::CommandReturnObject &</div> 152<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a9aa3311eea3bcb0507bcf9fb9c88ee28">operator*</a>() <span class="keyword">const</span>;</div> 153<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div> 154<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  lldb_private::CommandReturnObject &</div> 155<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a1311384290cf3721124ae5c31121647c">ref</a>() <span class="keyword">const</span>;</div> 156<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div> 157<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">void</span></div> 158<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="classlldb_1_1SBCommandReturnObject.html#a9ce6d1f02889943febb7a3ec6827f547">SetLLDBObjectPtr</a> (lldb_private::CommandReturnObject *ptr);</div> 159<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div> 160<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">private</span>:</div> 161<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  std::unique_ptr<lldb_private::CommandReturnObject> m_opaque_ap;</div> 162<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> };</div> 163<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div> 164<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> } <span class="comment">// namespace lldb</span></div> 165<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div> 166<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#endif // LLDB_SBCommandReturnObject_h_</span></div> 167</div><!-- fragment --></div><!-- contents --> 168<hr> 169<p class="footer"> 170Generated on Fri Jul 19 2013 13:25:55 for <a href="http://lldb.llvm.org/">LLVM</a> by 171<a href="http://www.doxygen.org"><img src="doxygen.png" alt="Doxygen" 172align="middle" border="0"/>1.8.1.2</a><br> 173Copyright © 2003-2013 University of Illinois at Urbana-Champaign. 174All Rights Reserved.</p> 175<hr> 176<!--#include virtual="/attrib.incl" --> 177</body> 178</html> 179
