blob: 05f0e7111cbfeb5f544dfd7a439608d8195b060c (
plain)
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
|
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Mozilla/4.77C-CCK-MCD Caldera Systems OpenLinux [en] (X11; U; Linux 2.4.2 i686) [Netscape]">
<title>OpenSLP Programmers Guide - SLPEscape()</title>
</head>
<body text="#000000" bgcolor="#FFFFFF" link="#0000EF" vlink="#51188E" alink="#FF0000">
<h2>
SLPEscape</h2>
<hr WIDTH="100%">
<h3>
Declaration</h3>
<tt>#include <slp.h></tt>
<p><tt><a href="/SLPError.html">SLPError</a> SLPEscape( const char* <a href="#unescaped">unescaped</a>,</tt>
<br><tt>
char** <a href="#escaped">escaped</a>,</tt>
<br><tt>
<a href="SLPTypes.html#SLPBoolean">SLPBoolean</a> <a href="#ist">istag</a>
)</tt>
<h3>
Description</h3>
Process the input string to escape any SLP reserved characters. If
the <tt>istag</tt> parameter is SLP_TRUE then SLPEscape() will look for
bad tag characters.
<h3>
Parameters</h3>
<table BORDER CELLPADDING=5 NOSAVE >
<tr VALIGN=TOP NOSAVE>
<td NOSAVE><a NAME="unescaped"></a><tt>unescaped</tt></td>
<td NOSAVE>Pointer to the string to be escaped</td>
</tr>
<tr VALIGN=TOP NOSAVE>
<td NOSAVE><a NAME="escaped"></a>escaped</td>
<td NOSAVE>Pointer to a pointer for the dynamically allocated output string.
The memory should be freed by a call to <a href="SLPFree.html">SLPFree()</a>
when no longer needed.</td>
</tr>
<tr VALIGN=TOP NOSAVE>
<td><a NAME="ist"></a>istag</td>
<td NOSAVE>When SLP_TRUE the input buffer is checked for bad characters</td>
</tr>
</table>
<h3>
Returns</h3>
<table BORDER NOSAVE >
<tr>
<td>SLP_OK</td>
<td>Indicates that the no error occurred during the operation.</td>
</tr>
<tr>
<td>SLP_PARSE_ERROR</td>
<td>The API returns this error only when no information was retrieved,
and at least one SA or DA indicated a protocol error. The data supplied
through the API may be malformed or a may have been damaged in transit.</td>
</tr>
<tr>
<td>SLP_MEMORY_ALLOC_FAILED </td>
<td>Out of memory error</td>
</tr>
<tr>
<td>SLP_PARAMETER_BAD</td>
<td>If a parameter passed into a function is bad, this error is returned.</td>
</tr>
</table>
<h3>
Status</h3>
<table CELLPADDING=5 NOSAVE >
<tr VALIGN=TOP NOSAVE>
<td NOSAVE>OpenSLP 0.6.7</td>
<td NOSAVE>Fully implemented as specified by RFC 2614.</td>
</tr>
</table>
<h3>
See Also</h3>
<a href="SLPUnescape.html">SLPUnescape()</a>, <a href="SLPFree.html">SLPFree()</a>
</body>
</html>
|
