<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Defines a type for use with other w32api_functions</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.w32api.html">W32api Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.w32api-init-dtype.html">w32api_init_dtype</a></div>
<div class="up"><a href="ref.w32api.html">W32api Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.w32api-deftype" class="refentry">
<div class="refnamediv">
<h1 class="refname">w32api_deftype</h1>
<p class="verinfo">(PHP 4 >= 4.2.0)</p><p class="refpurpose"><span class="refname">w32api_deftype</span> — <span class="dc-title">Defines a type for use with other w32api_functions</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.w32api-deftype-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>w32api_deftype</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$typename</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$member1_type</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$member1_name</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$...</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$...</code></span>
]] )</div>
<p class="para rdfs-comment">
You need to call this function if you would like to define a type for a
w32api call.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.w32api-deftype-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">typename</code></em></span>
<dd>
<p class="para">
The name of the type.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">member1_type</code></em></span>
<dd>
<p class="para">
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.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">member1_name</code></em></span>
<dd>
<p class="para">
The member name of <em><code class="parameter">member1_type</code></em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">...</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">...</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</p>
<p class="para">
This function takes 2n+1 arguments, where n is the number of members the
type has. After that is the type of the member followed by the members
name (in pairs).
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.w32api-deftype-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.w32api-deftype-notes">
<h3 class="title">Notes</h3>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
<em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
</p></div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.w32api.html">W32api Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.w32api-init-dtype.html">w32api_init_dtype</a></div>
<div class="up"><a href="ref.w32api.html">W32api Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
