sapi-windows-cp-get.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.sapi-windows-cp-get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>sapi_windows_cp_get</refname>
  <refpurpose>Get current codepage</refpurpose>
 </refnamediv>

 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>sapi_windows_cp_get</methodname>
   <methodparam choice="opt"><type>string</type><parameter>kind</parameter><initializer>""</initializer></methodparam>
  </methodsynopsis>
  <para>
   Gets the current codepage.
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>kind</parameter></term>
    <listitem>
     <para>
      The kind of operating system codepage to get,
      either <literal>'ansi'</literal> or <literal>'oem'</literal>.
      Any other value refers to the current codepage of the process.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1><!-- }}} -->

 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   If <parameter>kind</parameter> is <literal>'ansi'</literal>,
   the current <acronym>ANSI</acronym> code page of the operating system is returned.
   If <parameter>kind</parameter> is <literal>'oem'</literal>,
   the current <acronym>OEM</acronym> code page of the operating system is returned.
   Otherwise, the current codepage of the process is returned.
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="seealso"><!-- {{{ -->
  &reftitle.seealso;
  <simplelist>
   <member><function>sapi_windows_cp_set</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
-->