2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
<!ENTITY version SYSTEM "version.xml">
7
<refentry id="goffice-GoReg">
9
<refentrytitle role="top_of_page" id="goffice-GoReg.top_of_page">GoReg</refentrytitle>
10
<manvolnum>3</manvolnum>
11
<refmiscinfo>GOFFICE Library</refmiscinfo>
15
<refname>GoReg</refname>
16
<refpurpose></refpurpose>
17
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
20
<refsynopsisdiv id="goffice-GoReg.synopsis" role="synopsis">
21
<title role="synopsis.title">Synopsis</title>
24
#define <link linkend="REG-OK:CAPS">REG_OK</link>
25
<link linkend="GORegexp">GORegexp</link>;
26
typedef <link linkend="GORegoff">GORegoff</link>;
27
<link linkend="GORegmatch">GORegmatch</link>;
28
<link linkend="int">int</link> <link linkend="go-regcomp">go_regcomp</link> (<link linkend="GORegexp">GORegexp</link> *preg,
29
const <link linkend="char">char</link> *pattern,
30
<link linkend="int">int</link> cflags);
31
<link linkend="int">int</link> <link linkend="go-regexec">go_regexec</link> (const <link linkend="GORegexp">GORegexp</link> *preg,
32
const <link linkend="char">char</link> *string,
33
<link linkend="size-t">size_t</link> nmatch,
34
<link linkend="GORegmatch">GORegmatch</link> pmatch[],
35
<link linkend="int">int</link> eflags);
36
<link linkend="size-t">size_t</link> <link linkend="go-regerror">go_regerror</link> (<link linkend="int">int</link> errcode,
37
const <link linkend="GORegexp">GORegexp</link> *preg,
38
<link linkend="char">char</link> *errbuf,
39
<link linkend="size-t">size_t</link> errbuf_size);
40
<link linkend="void">void</link> <link linkend="go-regfree">go_regfree</link> (<link linkend="GORegexp">GORegexp</link> *preg);
41
const <link linkend="char">char</link>* <link linkend="go-regexp-quote1">go_regexp_quote1</link> (<link linkend="GString">GString</link> *target,
42
const <link linkend="char">char</link> *s);
43
<link linkend="void">void</link> <link linkend="go-regexp-quote">go_regexp_quote</link> (<link linkend="GString">GString</link> *target,
44
const <link linkend="char">char</link> *s);
56
<refsect1 id="goffice-GoReg.description" role="desc">
57
<title role="desc.title">Description</title>
63
<refsect1 id="goffice-GoReg.details" role="details">
64
<title role="details.title">Details</title>
65
<refsect2 id="REG-OK:CAPS" role="macro">
67
<indexterm zone="REG-OK:CAPS"><primary>REG_OK</primary></indexterm><programlisting>#define REG_OK REG_NOERROR
72
<refsect2 id="GORegexp" role="struct">
73
<title>GORegexp</title>
74
<indexterm zone="GORegexp"><primary>GORegexp</primary></indexterm><programlisting>typedef struct {
81
<refsect2 id="GORegoff" role="typedef">
82
<title>GORegoff</title>
83
<indexterm zone="GORegoff"><primary>GORegoff</primary></indexterm><programlisting>typedef int GORegoff;
88
<refsect2 id="GORegmatch" role="struct">
89
<title>GORegmatch</title>
90
<indexterm zone="GORegmatch"><primary>GORegmatch</primary></indexterm><programlisting>typedef struct {
91
GORegoff rm_so, rm_eo;
97
<refsect2 id="go-regcomp" role="function">
98
<title>go_regcomp ()</title>
99
<indexterm zone="go-regcomp"><primary>go_regcomp</primary></indexterm><programlisting><link linkend="int">int</link> go_regcomp (<link linkend="GORegexp">GORegexp</link> *preg,
100
const <link linkend="char">char</link> *pattern,
101
<link linkend="int">int</link> cflags);</programlisting>
104
</para><variablelist role="params">
105
<varlistentry><term><parameter>preg</parameter> :</term>
107
</simpara></listitem></varlistentry>
108
<varlistentry><term><parameter>pattern</parameter> :</term>
110
</simpara></listitem></varlistentry>
111
<varlistentry><term><parameter>cflags</parameter> :</term>
113
</simpara></listitem></varlistentry>
114
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
117
</simpara></listitem></varlistentry>
118
</variablelist></refsect2>
119
<refsect2 id="go-regexec" role="function">
120
<title>go_regexec ()</title>
121
<indexterm zone="go-regexec"><primary>go_regexec</primary></indexterm><programlisting><link linkend="int">int</link> go_regexec (const <link linkend="GORegexp">GORegexp</link> *preg,
122
const <link linkend="char">char</link> *string,
123
<link linkend="size-t">size_t</link> nmatch,
124
<link linkend="GORegmatch">GORegmatch</link> pmatch[],
125
<link linkend="int">int</link> eflags);</programlisting>
128
</para><variablelist role="params">
129
<varlistentry><term><parameter>preg</parameter> :</term>
131
</simpara></listitem></varlistentry>
132
<varlistentry><term><parameter>string</parameter> :</term>
134
</simpara></listitem></varlistentry>
135
<varlistentry><term><parameter>nmatch</parameter> :</term>
137
</simpara></listitem></varlistentry>
138
<varlistentry><term><parameter>pmatch</parameter> :</term>
140
</simpara></listitem></varlistentry>
141
<varlistentry><term><parameter>eflags</parameter> :</term>
143
</simpara></listitem></varlistentry>
144
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
147
</simpara></listitem></varlistentry>
148
</variablelist></refsect2>
149
<refsect2 id="go-regerror" role="function">
150
<title>go_regerror ()</title>
151
<indexterm zone="go-regerror"><primary>go_regerror</primary></indexterm><programlisting><link linkend="size-t">size_t</link> go_regerror (<link linkend="int">int</link> errcode,
152
const <link linkend="GORegexp">GORegexp</link> *preg,
153
<link linkend="char">char</link> *errbuf,
154
<link linkend="size-t">size_t</link> errbuf_size);</programlisting>
157
</para><variablelist role="params">
158
<varlistentry><term><parameter>errcode</parameter> :</term>
160
</simpara></listitem></varlistentry>
161
<varlistentry><term><parameter>preg</parameter> :</term>
163
</simpara></listitem></varlistentry>
164
<varlistentry><term><parameter>errbuf</parameter> :</term>
166
</simpara></listitem></varlistentry>
167
<varlistentry><term><parameter>errbuf_size</parameter> :</term>
169
</simpara></listitem></varlistentry>
170
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
173
</simpara></listitem></varlistentry>
174
</variablelist></refsect2>
175
<refsect2 id="go-regfree" role="function">
176
<title>go_regfree ()</title>
177
<indexterm zone="go-regfree"><primary>go_regfree</primary></indexterm><programlisting><link linkend="void">void</link> go_regfree (<link linkend="GORegexp">GORegexp</link> *preg);</programlisting>
180
</para><variablelist role="params">
181
<varlistentry><term><parameter>preg</parameter> :</term>
185
</simpara></listitem></varlistentry>
186
</variablelist></refsect2>
187
<refsect2 id="go-regexp-quote1" role="function">
188
<title>go_regexp_quote1 ()</title>
189
<indexterm zone="go-regexp-quote1"><primary>go_regexp_quote1</primary></indexterm><programlisting>const <link linkend="char">char</link>* go_regexp_quote1 (<link linkend="GString">GString</link> *target,
190
const <link linkend="char">char</link> *s);</programlisting>
193
</para><variablelist role="params">
194
<varlistentry><term><parameter>target</parameter> :</term>
196
</simpara></listitem></varlistentry>
197
<varlistentry><term><parameter>s</parameter> :</term>
199
</simpara></listitem></varlistentry>
200
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
203
</simpara></listitem></varlistentry>
204
</variablelist></refsect2>
205
<refsect2 id="go-regexp-quote" role="function">
206
<title>go_regexp_quote ()</title>
207
<indexterm zone="go-regexp-quote"><primary>go_regexp_quote</primary></indexterm><programlisting><link linkend="void">void</link> go_regexp_quote (<link linkend="GString">GString</link> *target,
208
const <link linkend="char">char</link> *s);</programlisting>
211
</para><variablelist role="params">
212
<varlistentry><term><parameter>target</parameter> :</term>
214
</simpara></listitem></varlistentry>
215
<varlistentry><term><parameter>s</parameter> :</term>
219
</simpara></listitem></varlistentry>
220
</variablelist></refsect2>