📄 classpbase64.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>PBase64 class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>PBase64 Class Reference</h1><code>#include <<a class="el" href="cypher_8h-source.html">cypher.h</a>></code><p><p>Inheritance diagram for PBase64:<p><center><img src="classPBase64.png" usemap="#PBase64_map" border="0" alt=""></center><map name="PBase64_map"><area href="classPObject.html" alt="PObject" shape="rect" coords="0,0,62,24"></map><a href="classPBase64-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Public Methods</h2></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPBase64.html#a0">PBase64</a> ()</td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPBase64.html#a1">StartEncoding</a> (BOOL useCRLFs=TRUE)</td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPBase64.html#a2">ProcessEncoding</a> (const <a class="el" href="classPString.html">PString</a> &str)</td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPBase64.html#a3">ProcessEncoding</a> (const char *cstr)</td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPBase64.html#a4">ProcessEncoding</a> (const <a class="el" href="classPBYTEArray.html">PBYTEArray</a> &data)</td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPBase64.html#a5">ProcessEncoding</a> (const void *dataBlock, PINDEX length)</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPBase64.html#a6">GetEncodedString</a> ()</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPBase64.html#a7">CompleteEncoding</a> ()</td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPBase64.html#a8">StartDecoding</a> ()</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPBase64.html#a9">ProcessDecoding</a> (const <a class="el" href="classPString.html">PString</a> &str)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPBase64.html#a10">ProcessDecoding</a> (const char *cstr)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPBase64.html#a11">GetDecodedData</a> (void *dataBlock, PINDEX length)</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPBYTEArray.html">PBYTEArray</a> </td><td valign=bottom><a class="el" href="classPBase64.html#a12">GetDecodedData</a> ()</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPBase64.html#a13">IsDecodeOK</a> ()</td></tr><tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPBase64.html#d0">Encode</a> (const <a class="el" href="classPString.html">PString</a> &str)</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPBase64.html#d1">Encode</a> (const char *cstr)</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPBase64.html#d2">Encode</a> (const <a class="el" href="classPBYTEArray.html">PBYTEArray</a> &data)</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPBase64.html#d3">Encode</a> (const void *dataBlock, PINDEX length)</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPBase64.html#d4">Decode</a> (const <a class="el" href="classPString.html">PString</a> &str)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPBase64.html#d5">Decode</a> (const <a class="el" href="classPString.html">PString</a> &str, <a class="el" href="classPBYTEArray.html">PBYTEArray</a> &data)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPBase64.html#d6">Decode</a> (const <a class="el" href="classPString.html">PString</a> &str, void *dataBlock, PINDEX length)</td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>This class is used to encode/decode data using the MIME standard base64 encoding mechanism as defined in RFC1521.<p>To encode a large block of data use the following seqeunce: \begin{verbatim} PBase64 base; base.StartEncoding(); while (Read(dataChunk)) { base.ProcessEncoding(dataChunk); out << base.GetEncodedString(); } out << base.CompleteEncoding(); \end{verbatim}<p>if smaller blocks that fit easily in memory are to be encoded the <a class="el" href="classPBase64.html#d0">Encode()</a># functions can be used to everything in one go.<p>To decode a large block of data use the following sequence: \begin{verbatim}<p>PBase64 base; base.StartDecoding(); while (Read(str) && ProcessDecoding(str)) Write(base.GetDecodedData()); Write(base.GetDecodedData()); \end{verbatim}<p>if smaller blocks that fit easily in memory are to be decoded the <a class="el" href="classPBase64.html#d4">Decode()</a># functions can be used to everything in one go. <p><hr><h2>Constructor & Destructor Documentation</h2><a name="a0" doxytag="PBase64::PBase64"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PBase64::PBase64 </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Construct a base 64 encoder/decoder and initialise both encode and decode members as in <a class="el" href="classPBase64.html#a1">StartEncoding()</a># and <a class="el" href="classPBase64.html#a8">StartDecoding()</a>#. </td> </tr></table><hr><h2>Member Function Documentation</h2><a name="a7" doxytag="PBase64::CompleteEncoding"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classPString.html">PString</a> PBase64::CompleteEncoding </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Complete the base 64 encoding and return the remainder of the encoded Base64 string. Previous data may have been already removed by the GetInterim()# function.<p><dl compact><dt><b>Returns: </b></dt><dd> Base64 encoded string for the processed data. </dl> </td> </tr></table><a name="d6" doxytag="PBase64::Decode"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> BOOL PBase64::Decode </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>str</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>void * </td> <td class="mdname" nowrap> <em>dataBlock</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>PINDEX </td> <td class="mdname" nowrap> <em>length</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><a name="d5" doxytag="PBase64::Decode"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> BOOL PBase64::Decode </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>str</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classPBYTEArray.html">PBYTEArray</a> & </td> <td class="mdname" nowrap> <em>data</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><a name="d4" doxytag="PBase64::Decode"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classPString.html">PString</a> PBase64::Decode </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname1" valign="top" nowrap> <em>str</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [static]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Convert a printable text string to binary data using the Internet MIME standard base 64 content transfer encoding.<p>The base64 string is checked and TRUE returned if all perfectly correct. If FALSE is returned then the string had extraneous or illegal characters in it that were ignored. This does not mean that the data is not valid, only that it is suspect.<p><dl compact><dt><b>Returns: </b></dt><dd> Base 64 string decoded from input string. </dl> </td> </tr></table><a name="d3" doxytag="PBase64::Encode"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classPString.html">PString</a> PBase64::Encode </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const void * </td> <td class="mdname" nowrap> <em>dataBlock</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>PINDEX </td> <td class="mdname" nowrap> <em>length</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><a name="d2" doxytag="PBase64::Encode"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classPString.html">PString</a> PBase64::Encode </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPBYTEArray.html">PBYTEArray</a> & </td> <td class="mdname1" valign="top" nowrap> <em>data</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [static]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><a name="d1" doxytag="PBase64::Encode"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classPString.html">PString</a> PBase64::Encode </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const char * </td> <td class="mdname1" valign="top" nowrap> <em>cstr</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [static]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><a name="d0" doxytag="PBase64::Encode"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classPString.html">PString</a> PBase64::Encode </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname1" valign="top" nowrap> <em>str</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [static]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><a name="a12" doxytag="PBase64::GetDecodedData"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classPBYTEArray.html">PBYTEArray</a> PBase64::GetDecodedData </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -