1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META http-equiv="Content-Style-Type" content="text/css">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 6.5.0.0 for Windows">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8<TITLE>HIO2Open</TITLE>
9</HEAD>
10<BODY>
11<H1 align="left">HIO2Open</H1>
12
13<H2>Syntax</H2>
14<P><STRONG>Target:</STRONG></P>
15<dl><dd><pre class="construction">
16#include &lt;revolution/hio2.h&gt;
17
18HIO2Handle    HIO2Open( HIO2DeviceType type, HIO2ReceiveCallback callback,
19                        HIO2DisconnectCallback disconnect );
20</pre></dd></dl>
21
22<P><STRONG>Host:</STRONG></P>
23<dl><dd><pre class="construction">
24#include &lt;revolution/hio2.h&gt;
25
26HIO2Handle    HIO2Open( HIO2DevicePath pathName, HIO2ReceiveCallback callback,
27                        HIO2NotifyCallback notify, void *param );
28</pre></dd></dl>
29
30<H2>Arguments</H2>
31<P><STRONG>Target:</STRONG></P>
32<TABLE class="arguments" border="1" >
33  <TBODY>
34    <TR>
35<TH>type</TH>
36<TD>EXI device type.</TD>
37    </TR>
38    <TR>
39<TH>callback</TH>
40<TD>Callback function called when a send notification (mailbox write) from a connected partner is detected.</TD>
41    </TR>
42    <TR>
43<TH>disconnect</TH>
44<TD>Callback function called when the device is disconnected.</TD>
45    </TR>
46  </TBODY>
47</TABLE>
48<P><STRONG>Host:</STRONG></P>
49<TABLE class="arguments" border="1" >
50  <TBODY>
51    <TR>
52<TH>pathName</TH>
53<TD>Device path name.</TD>
54    </TR>
55    <TR>
56<TH>callback</TH>
57<TD>Callback function called when a send notification (mailbox write) from a connected partner is detected.</TD>
58    </TR>
59    <TR>
60<TH>notify</TH>
61<TD>Callback function that is called if the <CODE>HIO2Open</CODE> function is called for a device that another process is using.</TD>
62    </TR>
63    <TR>
64<TH>param</TH>
65<TD>Parameter used with the callback function <SPAN class="argument">notify</SPAN>.</TD>
66    </TR>
67  </TBODY>
68</TABLE>
69
70<H2>Return Values</H2>
71<P>If handle retrieval fails, this function returns <CODE>HIO2_INVALID_HANDLE_VALUE</CODE>; if successful, some other value is returned.</P>
72
73<H2>Description</H2>
74<P><STRONG>Target:</STRONG> The <CODE>HIO2Open</CODE> function opens the specified EXI device.</P>
75<P>If the callback function <SPAN class="argument">callback</SPAN> has been specified, this callback function is called when a send notification (mailbox write) from a connected partner is detected while the HI02 function does internal processing.</P>
76<P>To detect that a device was disconnected, you must specify the callback function  <SPAN class="argument">disconnect</SPAN>.</P>
77<P><STRONG>Host:</STRONG> The <CODE>HIO2Open</CODE> function opens the specified device path.
78<P>If the callback function <SPAN class="argument">callback</SPAN> has been specified, this callback function is called when a send notification (mailbox write) from a connected partner is detected while the HI02 function does internal processing.
79<P>The following dialog box is displayed if another process is using the specified device path.
80<P><img src="HIO2OpenCaution.gif" border="0"></P>
81<P>PID indicates the process ID and Module is the process' file name.</P>
82<P>If <STRONG>Stop</STRONG> is selected, the <CODE>HIO2Open</CODE> function results in an error; if <STRONG>Retry</STRONG> is selected, initialization is reattempted.
83<P>If <STRONG>Retry</STRONG> is selected after the corresponding process terminates, the <CODE>HIO2Open</CODE> function succeeds.
84<P>If <STRONG>Ignore</STRONG> is selected, it sends a request to issue the <CODE>HIO2Exit</CODE> function to the corresponding process. (The library automatically receives the request internally and executes <CODE>HIO2Exit</CODE>.))
85<P>The callback function <SPAN class="argument">notify</SPAN> must be specified in order to detect that another process has called the <CODE>HIO2Open</CODE> function.
86
87<H2>See Also</H2>
88<P class="reference">
89<A href="HIO2Init.html">HIO2Init</A>,
90<A href="HIO2EnumDevices.html">HIO2EnumDevices</A>,
91<A href="HIO2Handle.html">HIO2Handle</A>,
92<A href="HIO2Exit.html">HIO2Exit</A>,
93<A href="HIO2ReceiveCallback.html">HIO2ReceiveCallback</A>,
94<A href="HIO2DisconnectCallback.html">HIO2DisconnectCallback</A>
95</P>
96
97<H2>Revision History</H2>
98<P>
992006/07/26 Corrected mistake in the types of the arguments of <CODE>HIO2Open</CODE> on the host side.<br>2006/05/29 Added links to <CODE>HIO2ReceiveCallback</CODE> and <CODE>HIO2DisconnectCallback</CODE>.<br>2006/03/01 Initial version.<br>
100</P>
101
102<hr><p>CONFIDENTIAL</p></body>
103</HTML>