File: w32api-deftype.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (52 lines) | stat: -rw-r--r-- 1,974 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/w32api.xml, last change in rev 1.1 -->
  <refentry id="function.w32api-deftype">
   <refnamediv>
    <refname>w32api_deftype</refname>
    <refpurpose>Defines a type for use with other w32api_functions</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>w32api_deftype</methodname>
      <methodparam><type>string</type><parameter>typename</parameter></methodparam>
      <methodparam><type>string</type><parameter>member1_type</parameter></methodparam>
      <methodparam><type>string</type><parameter>member1_name</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>...</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>...</parameter></methodparam>
     </methodsynopsis>
     &warn.experimental.func;
    <para>
     If you would like to define a type for a w32api call, you need to call
     <function>w32api_deftype</function>. This function takes 2n+1 arguments,
     where n is the number of members the type has. The first argument is the
     name of the type. After that is the type of the member followed by the
     members name (in pairs). A member type can be a user defined type. All
     the type names are case sensitive. Built in type names should be provided
     in lowercase.
     &return.success;
    </para>
   </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:"../../../../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
-->