File: structoscap__string__map.html

package info (click to toggle)
openscap 0.5.12-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 27,052 kB
  • ctags: 21,075
  • sloc: xml: 82,351; ansic: 52,101; sh: 17,802; makefile: 748; perl: 442; cpp: 117; python: 110
file content (131 lines) | stat: -rw-r--r-- 7,338 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<!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"/>
<title>Open SCAP Library: oscap_string_map Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>oscap_string_map Struct Reference</h1><!-- doxytag: class="oscap_string_map" -->
<p>Define mapping between symbolic constant and its string representation.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="util_8h_source.html">util.h</a>&gt;</code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__string__map.html#a6bda0f46c76ca15d381bbc08d932dfaa">oscap_string_to_enum</a> (const struct <a class="el" href="structoscap__string__map.html">oscap_string_map</a> *map, const char *str)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert a string to an enumeration constant.  <a href="#a6bda0f46c76ca15d381bbc08d932dfaa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__string__map.html#aa1d9de0387526ec8dbb26b494ef1703d">oscap_enum_to_string</a> (const struct <a class="el" href="structoscap__string__map.html">oscap_string_map</a> *map, int val)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert an enumeration constant to its corresponding string representation.  <a href="#aa1d9de0387526ec8dbb26b494ef1703d"></a><br/></td></tr>
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9829b586421a58d05b777b7c04f26394"></a><!-- doxytag: member="oscap_string_map::value" ref="a9829b586421a58d05b777b7c04f26394" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf5a6e02a988e5285f7bef49625127c0"></a><!-- doxytag: member="oscap_string_map::string" ref="adf5a6e02a988e5285f7bef49625127c0" args="" -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>string</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Define mapping between symbolic constant and its string representation. </p>
<p>It is supposed to define array of these structures, ending with element with the <em>string</em> member set to NULL. Value of such member also defines the default value for strings not defined elsewhere. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa1d9de0387526ec8dbb26b494ef1703d"></a><!-- doxytag: member="oscap_string_map::oscap_enum_to_string" ref="aa1d9de0387526ec8dbb26b494ef1703d" args="(const struct oscap_string_map *map, int val)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char * oscap_enum_to_string </td>
          <td>(</td>
          <td class="paramtype">const struct <a class="el" href="structoscap__string__map.html">oscap_string_map</a> *&nbsp;</td>
          <td class="paramname"> <em>map</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>val</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Convert an enumeration constant to its corresponding string representation. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>map</em>&nbsp;</td><td>An array of <a class="el" href="structoscap__string__map.html" title="Define mapping between symbolic constant and its string representation.">oscap_string_map</a> structures that defines mapping between constants and strings. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>value to be converted </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a6bda0f46c76ca15d381bbc08d932dfaa"></a><!-- doxytag: member="oscap_string_map::oscap_string_to_enum" ref="a6bda0f46c76ca15d381bbc08d932dfaa" args="(const struct oscap_string_map *map, const char *str)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int oscap_string_to_enum </td>
          <td>(</td>
          <td class="paramtype">const struct <a class="el" href="structoscap__string__map.html">oscap_string_map</a> *&nbsp;</td>
          <td class="paramname"> <em>map</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>str</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Convert a string to an enumeration constant. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>map</em>&nbsp;</td><td>An array of <a class="el" href="structoscap__string__map.html" title="Define mapping between symbolic constant and its string representation.">oscap_string_map</a> structures that defines mapping between constants and strings. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>str</em>&nbsp;</td><td>string to be converted </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/pvrabec/project/openscap/openscap-0.5.12/src/common/<a class="el" href="util_8h_source.html">util.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 30 Jun 2010 for Open SCAP Library by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>