2019-09-20 18:39:40 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2019-04-14 06:36:34 +02:00
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
2019-09-20 18:39:40 +02:00
< meta name = "generator" content = "Doxygen 1.8.15" / >
2019-04-14 06:36:34 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > mastodon-cpp: Mastodon::return_base Struct Reference< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > mastodon-cpp
2019-09-20 18:39:40 +02:00
  < span id = "projectnumber" > 0.110.0< / span >
2019-04-14 06:36:34 +02:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2019-09-20 18:39:40 +02:00
<!-- Generated by Doxygen 1.8.15 -->
2019-04-14 06:36:34 +02:00
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */< / script >
< div id = "main-nav" > < / div >
< div id = "nav-path" class = "navpath" >
< ul >
< li class = "navelem" > < a class = "el" href = "namespaceMastodon.html" > Mastodon< / a > < / li > < li class = "navelem" > < a class = "el" href = "structMastodon_1_1return__base.html" > return_base< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "#pub-attribs" > Public Attributes< / a > |
< a href = "structMastodon_1_1return__base-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > Mastodon::return_base Struct Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > Basis for return types.
< a href = "structMastodon_1_1return__base.html#details" > More...< / a > < / p >
< p > < code > #include < < a class = "el" href = "return__types_8hpp_source.html" > return_types.hpp< / a > > < / code > < / p >
< div class = "dynheader" >
Inheritance diagram for Mastodon::return_base:< / div >
< div class = "dyncontent" >
< div class = "center" >
< img src = "structMastodon_1_1return__base.png" usemap = "#Mastodon::return_5Fbase_map" alt = "" / >
< map id = "Mastodon::return_5Fbase_map" name = "Mastodon::return_5Fbase_map" >
2019-09-20 18:39:40 +02:00
< area href = "structMastodon_1_1Easy_1_1return__entity.html" title = "Return types for calls that return a single Easy::Entity." alt = "Mastodon::Easy::return_entity< T >" shape = "rect" coords = "0,56,252,80" / >
< area href = "structMastodon_1_1Easy_1_1return__entity__vector.html" title = "Return types for calls that return multiple Easy::Entitys." alt = "Mastodon::Easy::return_entity_vector< T >" shape = "rect" coords = "262,56,514,80" / >
< area href = "structMastodon_1_1return__call.html" title = "Return type for API calls." alt = "Mastodon::return_call" shape = "rect" coords = "524,56,776,80" / >
< / map >
< / div > < / div >
2019-04-14 06:36:34 +02:00
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
2019-09-20 18:39:40 +02:00
< tr class = "memitem:ad08f011a810e67bb2bee01ebe5cde1fa" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structMastodon_1_1return__base.html#ad08f011a810e67bb2bee01ebe5cde1fa" > operator bool< / a > () const< / td > < / tr >
< tr class = "memdesc:ad08f011a810e67bb2bee01ebe5cde1fa" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > true if < a class = "el" href = "structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a" title = "Error code." > return_base::error_code< / a > is 0, otherwise false. < a href = "#ad08f011a810e67bb2bee01ebe5cde1fa" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ad08f011a810e67bb2bee01ebe5cde1fa" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a3331b0ca8f1c999fd6d21f4ce4b4e68f" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structMastodon_1_1return__base.html#a3331b0ca8f1c999fd6d21f4ce4b4e68f" > operator uint8_t< / a > () const< / td > < / tr >
< tr class = "memdesc:a3331b0ca8f1c999fd6d21f4ce4b4e68f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Same as < a class = "el" href = "structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a" title = "Error code." > return_base::error_code< / a > . < a href = "#a3331b0ca8f1c999fd6d21f4ce4b4e68f" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a3331b0ca8f1c999fd6d21f4ce4b4e68f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-04-14 06:36:34 +02:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-attribs" > < / a >
Public Attributes< / h2 > < / td > < / tr >
< tr class = "memitem:a12cebffae19249cac4c9e4ae9f95391a" > < td class = "memItemLeft" align = "right" valign = "top" > uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a" > error_code< / a > = 0< / td > < / tr >
< tr class = "memdesc:a12cebffae19249cac4c9e4ae9f95391a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > < a class = "el" href = "classMastodon_1_1API.html#error" > Error code< / a > . < a href = "#a12cebffae19249cac4c9e4ae9f95391a" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a12cebffae19249cac4c9e4ae9f95391a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab902d5ecac698fadbdcabcd99d0ce754" > < td class = "memItemLeft" align = "right" valign = "top" > string  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structMastodon_1_1return__base.html#ab902d5ecac698fadbdcabcd99d0ce754" > error_message< / a > < / td > < / tr >
< tr class = "memdesc:ab902d5ecac698fadbdcabcd99d0ce754" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > The error message, or "". < a href = "#ab902d5ecac698fadbdcabcd99d0ce754" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ab902d5ecac698fadbdcabcd99d0ce754" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-04-19 07:05:28 +02:00
< tr class = "memitem:af62546b8b4bb03899ddbec770065e0b6" > < td class = "memItemLeft" align = "right" valign = "top" > uint16_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structMastodon_1_1return__base.html#af62546b8b4bb03899ddbec770065e0b6" > http_error_code< / a > = 0< / td > < / tr >
< tr class = "memdesc:af62546b8b4bb03899ddbec770065e0b6" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > HTTP error code. < a href = "#af62546b8b4bb03899ddbec770065e0b6" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:af62546b8b4bb03899ddbec770065e0b6" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-04-14 06:36:34 +02:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > Basis for return types. < / p >
< dl class = "section since" > < dt > Since< / dt > < dd > 0.100.0 < / dd > < / dl >
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
2019-09-20 18:39:40 +02:00
< a id = "ad08f011a810e67bb2bee01ebe5cde1fa" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ad08f011a810e67bb2bee01ebe5cde1fa" > ◆ < / a > < / span > operator bool()< / h2 >
2019-04-14 06:36:34 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2019-09-20 18:39:40 +02:00
< td class = "memname" > Mastodon::return_base::operator bool < / td >
2019-04-14 06:36:34 +02:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
2019-09-20 18:39:40 +02:00
< td > const< / td >
2019-04-14 06:36:34 +02:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2019-09-20 18:39:40 +02:00
< p > true if < a class = "el" href = "structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a" title = "Error code." > return_base::error_code< / a > is 0, otherwise false. < / p >
2019-04-14 06:36:34 +02:00
< dl class = "section since" > < dt > Since< / dt > < dd > 0.100.0 < / dd > < / dl >
2019-09-20 18:39:40 +02:00
< div class = "fragment" > < div class = "line" > < a name = "l00022" > < / a > < span class = "lineno" > 22< / span >   {< / div > < div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > 23< / span >   < span class = "keywordflow" > if< / span > (< a class = "code" href = "structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a" > error_code< / a > == 0)< / div > < div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   {< / div > < div class = "line" > < a name = "l00025" > < / a > < span class = "lineno" > 25< / span >   < span class = "keywordflow" > return< / span > < span class = "keyword" > true< / span > ;< / div > < div class = "line" > < a name = "l00026" > < / a > < span class = "lineno" > 26< / span >   }< / div > < div class = "line" > < a name = "l00027" > < / a > < span class = "lineno" > 27< / span >   < span class = "keywordflow" > else< / span > < / div > < div class = "line" > < a name = "l00028" > < / a > < span class = "lineno" > 28< / span >   {< / div > < div class = "line" > < a name = "l00029" > < / a > < span class = "lineno" > 29< / span >   < span class = "keywordflow" > return< / span > < span class = "keyword" > false< / span > ;< / div > < div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   }< / div > < div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   }< / div > < div class = "ttc" id = "structMastodon_1_1return__base_html_a12cebffae19249cac4c9e4ae9f95391a" > < div class = "ttname" > < a href = "structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a" > Mastodon::return_base::error_code< / a > < / div > < div class = "ttdeci" > uint8_t error_code< / div > < div class = "ttdoc" > Error code.< / div > < div class = "ttdef" > < b > Definition:< / b > return_types.hpp:42< / div > < / div >
2019-04-14 06:36:34 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
2019-09-20 18:39:40 +02:00
< a id = "a3331b0ca8f1c999fd6d21f4ce4b4e68f" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a3331b0ca8f1c999fd6d21f4ce4b4e68f" > ◆ < / a > < / span > operator uint8_t()< / h2 >
2019-04-14 06:36:34 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2019-09-20 18:39:40 +02:00
< td class = "memname" > Mastodon::return_base::operator uint8_t < / td >
2019-04-14 06:36:34 +02:00
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
2019-09-20 18:39:40 +02:00
< td > const< / td >
2019-04-14 06:36:34 +02:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2019-09-20 18:39:40 +02:00
< p > Same as < a class = "el" href = "structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a" title = "Error code." > return_base::error_code< / a > . < / p >
2019-04-14 06:36:34 +02:00
< dl class = "section since" > < dt > Since< / dt > < dd > 0.100.0 < / dd > < / dl >
2019-09-20 18:39:40 +02:00
< div class = "fragment" > < div class = "line" > < a name = "l00034" > < / a > < span class = "lineno" > 34< / span >   {< / div > < div class = "line" > < a name = "l00035" > < / a > < span class = "lineno" > 35< / span >   < span class = "keywordflow" > return< / span > < a class = "code" href = "structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a" > error_code< / a > ;< / div > < div class = "line" > < a name = "l00036" > < / a > < span class = "lineno" > 36< / span >   }< / div > < div class = "ttc" id = "structMastodon_1_1return__base_html_a12cebffae19249cac4c9e4ae9f95391a" > < div class = "ttname" > < a href = "structMastodon_1_1return__base.html#a12cebffae19249cac4c9e4ae9f95391a" > Mastodon::return_base::error_code< / a > < / div > < div class = "ttdeci" > uint8_t error_code< / div > < div class = "ttdoc" > Error code.< / div > < div class = "ttdef" > < b > Definition:< / b > return_types.hpp:42< / div > < / div >
2019-04-14 06:36:34 +02:00
< / div > <!-- fragment -->
< / div >
< / div >
< h2 class = "groupheader" > Member Data Documentation< / h2 >
< a id = "a12cebffae19249cac4c9e4ae9f95391a" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a12cebffae19249cac4c9e4ae9f95391a" > ◆ < / a > < / span > error_code< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > uint8_t Mastodon::return_base::error_code = 0< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > < a class = "el" href = "classMastodon_1_1API.html#error" > Error code< / a > . < / p >
< dl class = "section since" > < dt > Since< / dt > < dd > 0.100.0 < / dd > < / dl >
2019-09-20 18:39:40 +02:00
< dl class = "section examples" > < dt > Examples< / dt > < dd > < a class = "el" href = "example01_get_public_timeline_8cpp-example.html#a11" > example01_get_public_timeline.cpp< / a > .< / dd >
2019-04-14 06:36:34 +02:00
< / dl >
2019-09-20 18:39:40 +02:00
2019-04-14 06:36:34 +02:00
< / div >
< / div >
< a id = "ab902d5ecac698fadbdcabcd99d0ce754" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab902d5ecac698fadbdcabcd99d0ce754" > ◆ < / a > < / span > error_message< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > string Mastodon::return_base::error_message< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > The error message, or "". < / p >
< dl class = "section since" > < dt > Since< / dt > < dd > 0.100.0 < / dd > < / dl >
2019-09-20 18:39:40 +02:00
< dl class = "section examples" > < dt > Examples< / dt > < dd > < a class = "el" href = "example01_get_public_timeline_8cpp-example.html#a9" > example01_get_public_timeline.cpp< / a > .< / dd >
2019-04-14 06:36:34 +02:00
< / dl >
2019-09-20 18:39:40 +02:00
2019-04-14 06:36:34 +02:00
< / div >
< / div >
2019-04-19 07:05:28 +02:00
< a id = "af62546b8b4bb03899ddbec770065e0b6" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#af62546b8b4bb03899ddbec770065e0b6" > ◆ < / a > < / span > http_error_code< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > uint16_t Mastodon::return_base::http_error_code = 0< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > HTTP error code. < / p >
< dl class = "section since" > < dt > Since< / dt > < dd > 0.100.0 < / dd > < / dl >
2019-09-20 18:39:40 +02:00
< dl class = "section examples" > < dt > Examples< / dt > < dd > < a class = "el" href = "example01_get_public_timeline_8cpp-example.html#a10" > example01_get_public_timeline.cpp< / a > .< / dd >
2019-04-19 07:05:28 +02:00
< / dl >
2019-09-20 18:39:40 +02:00
2019-04-19 07:05:28 +02:00
< / div >
< / div >
2019-04-14 06:36:34 +02:00
< hr / > The documentation for this struct was generated from the following files:< ul >
< li > src/< a class = "el" href = "return__types_8hpp_source.html" > return_types.hpp< / a > < / li >
< li > src/return_types.cpp< / li >
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
Generated by   < a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
2019-09-20 18:39:40 +02:00
< / a > 1.8.15
2019-04-14 06:36:34 +02:00
< / small > < / address >
< / body >
< / html >