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
|
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"file:///usr/share/xml/docbook/schema/dtd/4.2/docbookx.dtd">
<!--
Copyright Intel 2012
This manual page is licensed under the Creative Commons Attribution-ShareAlike 3.0 United States License (CC BY-SA 3.0
US). To view a copy of this license, visit http://creativecommons.org.license/by-sa/3.0/us.
-->
<refentry
id="waffle_enum"
xmlns:xi="http://www.w3.org/2001/XInclude">
<!-- See http://www.docbook.org/tdg/en/html/refentry.html. -->
<refmeta>
<refentrytitle>waffle_enum</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>waffle_enum</refname>
<refname>waffle_enum_to_string</refname>
<refpurpose>Utilities for waffle enums</refpurpose>
</refnamediv>
<refentryinfo>
<title>Waffle Manual</title>
<productname>waffle</productname>
<xi:include href="common/author-chad.versace.xml"/>
<xi:include href="common/copyright.xml"/>
<xi:include href="common/legalnotice.xml"/>
</refentryinfo>
<refsynopsisdiv>
<funcsynopsis language="C">
<funcsynopsisinfo>
#include <waffle.h>
enum waffle_enum {...};
</funcsynopsisinfo>
<funcprototype>
<funcdef>const char* <function>waffle_enum_to_string</function></funcdef>
<paramdef>int32_t <parameter>e</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<variablelist>
<varlistentry>
<term><function>waffle_enum_to_string()</function></term>
<listitem>
<para>
Convert an <type>waffle_enum</type> token to a string.
For example, convert <constant>WAFFLE_DONT_CARE</constant> to <code>"WAFFLE_DONT_CARE"</code>.
Return null if the token is not a valid <type>waffle_enum</type>.
</para>
<para>
This function always sets the error code to <constant>WAFFLE_NO_ERROR</constant>.
It can be called before waffle has been successfully initialized with
<citerefentry><refentrytitle><function>waffle_init</function></refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<xi:include href="common/issues.xml"/>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>waffle</refentrytitle><manvolnum>7</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
<!--
vim:tw=120 et ts=2 sw=2:
-->
|
