summaryrefslogtreecommitdiffstats
path: root/mimelib/doc/util.html
blob: 1ae75acf1bcc8b65db75be1aa3046cb06d879a5d (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
101
102
103
104
105
106
107
108
109
110
111
<!-- $Revision$ -->
<!-- $Date$ -->
<HTML>
<HEAD>
  <TITLE> MIME++ Utility Functions </TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<H2>
  <FONT COLOR="navy"> NAME </FONT>
</H2>
<P>
MIME++ Utilities
<H2>
  <FONT COLOR="navy"> SYNOPSIS </FONT>
</H2>
<PRE>#include &amp;ltmimepp/mimepp.h&gt;

void <A HREF="#DwInitialize">DwInitialize</A>();
int <A HREF="#DwToCrLfEol">DwToCrLfEol</A>(const DwString&amp; aSrcStr, DwString&amp; aDestStr);
int <A HREF="#DwToLfEol">DwToLfEol</A>(const DwString&amp; aSrcStr, DwString&amp; aDestStr);
int <A HREF="#DwToCrEol">DwToCrEol</A>(const DwString&amp; aSrcStr, DwString&amp; aDestStr);
int <A HREF="#DwToLocalEol">DwToLocalEol</A>(const DwString&amp; aSrcStr, DwString&amp; aDestStr);
int <A HREF="#DwEncodeBase64">DwEncodeBase64</A>(const DwString&amp; aSrcStr, DwString&amp; aDestStr);
int <A HREF="#DwDecodeBase64">DwDecodeBase64</A>(const DwString&amp; aSrcStr, DwString&amp; aDestStr);
int <A HREF="#DwEncodeQuotedPrintable">DwEncodeQuotedPrintable</A>(const DwString&amp; aSrcStr, DwString&amp; aDestStr);
int <A HREF="#DwDecodeQuotedPrintable">DwEncodeQuotedPrintable</A>(const DwString&amp; aSrcStr, DwString&amp; aDestStr);
</PRE>
<H2>
  <FONT COLOR="navy"> DESCRIPTION </FONT>
</H2>
<P>
<FONT COLOR="teal"><B> void <A NAME="DwInitialize">DwInitialize</A>();
</B></FONT>
<P>
Initializes the class library. Call this member function before creating
any objects from MIME++ classes.
<P>
<FONT COLOR="teal"><B> int <A NAME="DwToCrLfEol">DwToCrLfEol</A>(const
DwString&amp; aSrcStr, DwString&amp; aDestStr); </B></FONT>
<P>
Converts all end-of-line markers in <B><TT>aSrcStr</TT></B> to CR LF and
puts the result in <B><TT>aDestStr</TT></B>. The contract explicitly allows
<B><TT>aSrcStr</TT></B> and <B><TT>aDestStr</TT></B> to be references to
the same string.
<P>
<FONT COLOR="teal"><B> int <A NAME="DwToLfEol">DwToLfEol</A>(const
DwString&amp; aSrcStr, DwString&amp; aDestStr); </B></FONT>
<P>
Converts all end-of-line markers in <B><TT>aSrcStr</TT></B> to LF ('\n')
and puts the result in <B><TT>aDestStr</TT></B>. The contract explicitly
allows <B><TT>aSrcStr</TT></B> and <B><TT>aDestStr</TT></B> to be references
to the same string.
<P>
<FONT COLOR="teal"><B> int <A NAME="DwToCrEol">DwToCrEol</A>(const
DwString&amp; aSrcStr, DwString&amp; aDestStr); </B></FONT>
<P>
Converts all end-of-line markers in <B><TT>aSrcStr</TT></B> to CR ('\r')
and puts the result in <B><TT>aDestStr</TT></B>. The contract explicitly
allows <B><TT>aSrcStr</TT></B> and <B><TT>aDestStr</TT></B> to be references
to the same string.
<P>
<FONT COLOR="teal"><B> int <A NAME="DwToLocalEol">DwToLocalEol</A>(const
DwString&amp; aSrcStr, DwString&amp; aDestStr); </B></FONT>
<P>
Converts all end-of-line markers in <B><TT>aSrcStr</TT></B> to the end-of-line
marker native to the operating system and puts the result in
<B><TT>aDestStr</TT></B>. The contract explicitly allows
<B><TT>aSrcStr</TT></B> and <B><TT>aDestStr</TT></B> to be references to
the same string.
<P>
The end-of-line markers for various operating systems are the following:
<PRE>
   MS-DOS, WIN32     CR LF
   UNIX              LF
   Macintosh         CR
</PRE>
<P>
<FONT COLOR="teal"><B> int <A NAME="DwEncodeBase64">DwEncodeBase64</A>(const
DwString&amp; aSrcStr, DwString&amp; aDestStr); </B></FONT>
<P>
Encodes the characters in <B><TT>aSrcStr</TT></B> using the base64 encoding
and puts the result into <B><TT>aDestStr</TT></B>. The contract explicitly
allows <B><TT>aSrcStr</TT></B> and <B><TT>aDestStr</TT></B> to be references
to the same string.
<P>
<FONT COLOR="teal"><B> int <A NAME="DwDecodeBase64">DwDecodeBase64</A>(const
DwString&amp; aSrcStr, DwString&amp; aDestStr); </B></FONT>
<P>
Decodes the characters in <B><TT>aSrcStr</TT></B> from the base64 encoding
and puts the result into <B><TT>aDestStr</TT></B>. The contract explicitly
allows <B><TT>aSrcStr</TT></B> and <B><TT>aDestStr</TT></B> to be references
to the same string.
<P>
<FONT COLOR="teal"><B> int
<A NAME="DwEncodeQuotedPrintable">DwEncodeQuotedPrintable</A>(const
DwString&amp; aSrcStr, DwString&amp; aDestStr); </B></FONT>
<P>
Encodes the characters in <B><TT>aSrcStr</TT></B> using the quoted-printable
encoding and puts the result into <B><TT>aDestStr</TT></B>. The contract
explicitly allows <B><TT>aSrcStr</TT></B> and <B><TT>aDestStr</TT></B> to
be references to the same string.
<P>
<FONT COLOR="teal"><B> int
<A NAME="DwDecodeQuotedPrintable">DwDecodeQuotedPrintable</A>(const
DwString&amp; aSrcStr, DwString&amp; aDestStr); </B></FONT>
<P>
Decodes the characters in <B><TT>aSrcStr</TT></B> from the quoted-printable
encoding and puts the result into <B><TT>aDestStr</TT></B>. The contract
explicitly allows <B><TT>aSrcStr</TT></B> and <B><TT>aDestStr</TT></B> to
be references to the same string.
</BODY></HTML>