File: apc-bin-dump.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (85 lines) | stat: -rw-r--r-- 2,543 bytes parent folder | download
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 331388 $ -->

<refentry xml:id="function.apc-bin-dump" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>apc_bin_dump</refname>
  <refpurpose>Get a binary dump of the given files and user variables</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>apc_bin_dump</methodname>
   <methodparam choice="opt"><type>array</type><parameter>files</parameter><initializer>NULL</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>user_vars</parameter><initializer>NULL</initializer></methodparam>
  </methodsynopsis>
  <para>
   Returns a binary dump of the given files and user variables from the APC cache.
   A &null; for files or user_vars signals a dump of every entry, whereas array() will dump
   nothing.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>files</parameter></term>
    <listitem>
     <para>
      The files. Passing in &null; signals a dump of every entry, while
      passing in <function>array</function> will dump nothing.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>user_vars</parameter></term>
    <listitem>
     <para>
      The user vars. Passing in &null; signals a dump of every entry, while
      passing in <function>array</function> will dump nothing.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a binary dump of the given files and user variables from the APC cache,
   &false; if APC is not enabled, or &null; if an unknown error is encountered.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>apc_bin_dumpfile</function></member>
   <member><function>apc_bin_load</function></member>
  </simplelist>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->