mirror of
https://github.com/protobuf-c/protobuf-c.git
synced 2024-12-28 06:10:53 +08:00
338 lines
18 KiB
HTML
338 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<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"/>
|
|
<meta name="generator" content="Doxygen 1.8.8"/>
|
|
<title>protobuf-c: ProtobufCEnumDescriptor 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</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 style="padding-left: 0.5em;">
|
|
<div id="projectname">protobuf-c
|
|
 <span id="projectnumber">1.1.0</span>
|
|
</div>
|
|
<div id="projectbrief">Protocol Buffers implementation in C</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.8 -->
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('structProtobufCEnumDescriptor.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ProtobufCEnumDescriptor Struct Reference<div class="ingroups"><a class="el" href="group__api.html">Public API</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Describes an enumeration as a whole, with all of its values.
|
|
<a href="structProtobufCEnumDescriptor.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:ad250459fe036b88bd301b8f4c23a829f"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#ad250459fe036b88bd301b8f4c23a829f">magic</a></td></tr>
|
|
<tr class="memdesc:ad250459fe036b88bd301b8f4c23a829f"><td class="mdescLeft"> </td><td class="mdescRight">Magic value checked to ensure that the API is used correctly. <a href="#ad250459fe036b88bd301b8f4c23a829f">More...</a><br /></td></tr>
|
|
<tr class="separator:ad250459fe036b88bd301b8f4c23a829f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb6dadf12c152d24935d0149929d6c57"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#aeb6dadf12c152d24935d0149929d6c57">name</a></td></tr>
|
|
<tr class="memdesc:aeb6dadf12c152d24935d0149929d6c57"><td class="mdescLeft"> </td><td class="mdescRight">The qualified name (e.g., "namespace.Type"). <a href="#aeb6dadf12c152d24935d0149929d6c57">More...</a><br /></td></tr>
|
|
<tr class="separator:aeb6dadf12c152d24935d0149929d6c57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5632dbcef3d820edc20d2dbb37e4c523"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#a5632dbcef3d820edc20d2dbb37e4c523">short_name</a></td></tr>
|
|
<tr class="memdesc:a5632dbcef3d820edc20d2dbb37e4c523"><td class="mdescLeft"> </td><td class="mdescRight">The unqualified name as given in the .proto file (e.g., "Type"). <a href="#a5632dbcef3d820edc20d2dbb37e4c523">More...</a><br /></td></tr>
|
|
<tr class="separator:a5632dbcef3d820edc20d2dbb37e4c523"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12ff33de9fcf76b0194c7faaf01b389f"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#a12ff33de9fcf76b0194c7faaf01b389f">c_name</a></td></tr>
|
|
<tr class="memdesc:a12ff33de9fcf76b0194c7faaf01b389f"><td class="mdescLeft"> </td><td class="mdescRight">Identifier used in generated C code. <a href="#a12ff33de9fcf76b0194c7faaf01b389f">More...</a><br /></td></tr>
|
|
<tr class="separator:a12ff33de9fcf76b0194c7faaf01b389f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14f20e459fe97578ec858dd5bda57a46"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#a14f20e459fe97578ec858dd5bda57a46">package_name</a></td></tr>
|
|
<tr class="memdesc:a14f20e459fe97578ec858dd5bda57a46"><td class="mdescLeft"> </td><td class="mdescRight">The dot-separated namespace. <a href="#a14f20e459fe97578ec858dd5bda57a46">More...</a><br /></td></tr>
|
|
<tr class="separator:a14f20e459fe97578ec858dd5bda57a46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9997869ddd5db78ef7dc8cedcb63ac55"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#a9997869ddd5db78ef7dc8cedcb63ac55">n_values</a></td></tr>
|
|
<tr class="memdesc:a9997869ddd5db78ef7dc8cedcb63ac55"><td class="mdescLeft"> </td><td class="mdescRight">Number elements in <code>values</code>. <a href="#a9997869ddd5db78ef7dc8cedcb63ac55">More...</a><br /></td></tr>
|
|
<tr class="separator:a9997869ddd5db78ef7dc8cedcb63ac55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11e3a2302fae009d2f233b2259b1ee89"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structProtobufCEnumValue.html">ProtobufCEnumValue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#a11e3a2302fae009d2f233b2259b1ee89">values</a></td></tr>
|
|
<tr class="memdesc:a11e3a2302fae009d2f233b2259b1ee89"><td class="mdescLeft"> </td><td class="mdescRight">Array of distinct values, sorted by numeric value. <a href="#a11e3a2302fae009d2f233b2259b1ee89">More...</a><br /></td></tr>
|
|
<tr class="separator:a11e3a2302fae009d2f233b2259b1ee89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a266b2638ed5d7667e30d60937074ddef"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#a266b2638ed5d7667e30d60937074ddef">n_value_names</a></td></tr>
|
|
<tr class="memdesc:a266b2638ed5d7667e30d60937074ddef"><td class="mdescLeft"> </td><td class="mdescRight">Number of elements in <code>values_by_name</code>. <a href="#a266b2638ed5d7667e30d60937074ddef">More...</a><br /></td></tr>
|
|
<tr class="separator:a266b2638ed5d7667e30d60937074ddef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1274fbb26770d4fe1372060899ee592c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structProtobufCEnumValueIndex.html">ProtobufCEnumValueIndex</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#a1274fbb26770d4fe1372060899ee592c">values_by_name</a></td></tr>
|
|
<tr class="memdesc:a1274fbb26770d4fe1372060899ee592c"><td class="mdescLeft"> </td><td class="mdescRight">Array of named values, including aliases, sorted by name. <a href="#a1274fbb26770d4fe1372060899ee592c">More...</a><br /></td></tr>
|
|
<tr class="separator:a1274fbb26770d4fe1372060899ee592c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0fa9d0fa7aa68b8db06170ba270de248"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#a0fa9d0fa7aa68b8db06170ba270de248">n_value_ranges</a></td></tr>
|
|
<tr class="memdesc:a0fa9d0fa7aa68b8db06170ba270de248"><td class="mdescLeft"> </td><td class="mdescRight">Number of elements in <code>value_ranges</code>. <a href="#a0fa9d0fa7aa68b8db06170ba270de248">More...</a><br /></td></tr>
|
|
<tr class="separator:a0fa9d0fa7aa68b8db06170ba270de248"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7250f0caec6254df6b04d47b79688fd0"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structProtobufCIntRange.html">ProtobufCIntRange</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#a7250f0caec6254df6b04d47b79688fd0">value_ranges</a></td></tr>
|
|
<tr class="memdesc:a7250f0caec6254df6b04d47b79688fd0"><td class="mdescLeft"> </td><td class="mdescRight">Value ranges, for faster lookups by numeric value. <a href="#a7250f0caec6254df6b04d47b79688fd0">More...</a><br /></td></tr>
|
|
<tr class="separator:a7250f0caec6254df6b04d47b79688fd0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf33cb1808b09de33f543c7959216e07"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#acf33cb1808b09de33f543c7959216e07">reserved1</a></td></tr>
|
|
<tr class="memdesc:acf33cb1808b09de33f543c7959216e07"><td class="mdescLeft"> </td><td class="mdescRight">Reserved for future use. <a href="#acf33cb1808b09de33f543c7959216e07">More...</a><br /></td></tr>
|
|
<tr class="separator:acf33cb1808b09de33f543c7959216e07"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4308490468009f170bcf01c6240e0576"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#a4308490468009f170bcf01c6240e0576">reserved2</a></td></tr>
|
|
<tr class="memdesc:a4308490468009f170bcf01c6240e0576"><td class="mdescLeft"> </td><td class="mdescRight">Reserved for future use. <a href="#a4308490468009f170bcf01c6240e0576">More...</a><br /></td></tr>
|
|
<tr class="separator:a4308490468009f170bcf01c6240e0576"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33ddb9c25c9c4e9c8b5e6fee2cb9be7e"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#a33ddb9c25c9c4e9c8b5e6fee2cb9be7e">reserved3</a></td></tr>
|
|
<tr class="memdesc:a33ddb9c25c9c4e9c8b5e6fee2cb9be7e"><td class="mdescLeft"> </td><td class="mdescRight">Reserved for future use. <a href="#a33ddb9c25c9c4e9c8b5e6fee2cb9be7e">More...</a><br /></td></tr>
|
|
<tr class="separator:a33ddb9c25c9c4e9c8b5e6fee2cb9be7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61e99556da2d93ea7f74e93011435ecd"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCEnumDescriptor.html#a61e99556da2d93ea7f74e93011435ecd">reserved4</a></td></tr>
|
|
<tr class="memdesc:a61e99556da2d93ea7f74e93011435ecd"><td class="mdescLeft"> </td><td class="mdescRight">Reserved for future use. <a href="#a61e99556da2d93ea7f74e93011435ecd">More...</a><br /></td></tr>
|
|
<tr class="separator:a61e99556da2d93ea7f74e93011435ecd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Describes an enumeration as a whole, with all of its values. </p>
|
|
</div><h2 class="groupheader">Field Documentation</h2>
|
|
<a class="anchor" id="ad250459fe036b88bd301b8f4c23a829f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t ProtobufCEnumDescriptor::magic</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Magic value checked to ensure that the API is used correctly. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aeb6dadf12c152d24935d0149929d6c57"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* ProtobufCEnumDescriptor::name</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The qualified name (e.g., "namespace.Type"). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5632dbcef3d820edc20d2dbb37e4c523"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* ProtobufCEnumDescriptor::short_name</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The unqualified name as given in the .proto file (e.g., "Type"). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a12ff33de9fcf76b0194c7faaf01b389f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* ProtobufCEnumDescriptor::c_name</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Identifier used in generated C code. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a14f20e459fe97578ec858dd5bda57a46"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* ProtobufCEnumDescriptor::package_name</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The dot-separated namespace. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9997869ddd5db78ef7dc8cedcb63ac55"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned ProtobufCEnumDescriptor::n_values</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Number elements in <code>values</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a11e3a2302fae009d2f233b2259b1ee89"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="structProtobufCEnumValue.html">ProtobufCEnumValue</a>* ProtobufCEnumDescriptor::values</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Array of distinct values, sorted by numeric value. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a266b2638ed5d7667e30d60937074ddef"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned ProtobufCEnumDescriptor::n_value_names</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Number of elements in <code>values_by_name</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1274fbb26770d4fe1372060899ee592c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="structProtobufCEnumValueIndex.html">ProtobufCEnumValueIndex</a>* ProtobufCEnumDescriptor::values_by_name</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Array of named values, including aliases, sorted by name. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0fa9d0fa7aa68b8db06170ba270de248"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned ProtobufCEnumDescriptor::n_value_ranges</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Number of elements in <code>value_ranges</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7250f0caec6254df6b04d47b79688fd0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="structProtobufCIntRange.html">ProtobufCIntRange</a>* ProtobufCEnumDescriptor::value_ranges</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Value ranges, for faster lookups by numeric value. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acf33cb1808b09de33f543c7959216e07"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* ProtobufCEnumDescriptor::reserved1</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reserved for future use. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4308490468009f170bcf01c6240e0576"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* ProtobufCEnumDescriptor::reserved2</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reserved for future use. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a33ddb9c25c9c4e9c8b5e6fee2cb9be7e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* ProtobufCEnumDescriptor::reserved3</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reserved for future use. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a61e99556da2d93ea7f74e93011435ecd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* ProtobufCEnumDescriptor::reserved4</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reserved for future use. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="structProtobufCEnumDescriptor.html">ProtobufCEnumDescriptor</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|