pupnp (libupnp) snapshot from SourceForge: git clone git://pupnp.git.sourceforge...
[igd2-for-linux:pandonghui1211s-igd2-for-linux.git] / pupnp_branch-1.6.x / docs / dist / html / upnp / UpnpRegisterRootDevice.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <HTML>
4 <HEAD>
5    <TITLE>EXPORT_SPEC int UpnpRegisterRootDevice</TITLE>
6    <META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
7 </HEAD>
8 <BODY BGCOLOR="#ffffff">
9
10 <H2>EXPORT_SPEC int <A HREF="#DOC.DOCU">UpnpRegisterRootDevice</A></H2><H2>( IN const char* DescUrl,<BR>&nbsp;  IN Upnp_FunPtr Callback,<BR>&nbsp;  IN const void* Cookie,<BR>&nbsp;  OUT <!1><A HREF="UpnpDevice_Handle.html">UpnpDevice_Handle</A>* Hnd )</H2><BLOCKQUOTE><B>UpnpRegisterRootDevice</B> registers a device application with the SDK.</BLOCKQUOTE>
11
12 <A NAME="DOC.DOCU"></A>
13 <HR>
14 <H2>Documentation</H2>
15 <BLOCKQUOTE><B>UpnpRegisterRootDevice</B> registers a device application with
16 the SDK.  A device application cannot make any other API
17 calls until it registers using this function.  Device applications
18 can also register as control points (see <B>UpnpRegisterClient</B>
19 to get a control point handle to perform control point
20 functionality).
21
22 <P><B>UpnpRegisterRootDevice</B> is synchronous and does not generate
23 any callbacks.  Callbacks can occur as soon as this function returns.
24
25 <P></BLOCKQUOTE>
26 <DL><DT><DT><B>Parameters:</B><DD><B>DescUrl</B> -   Pointer to a string containing the 
27 description URL for this root device 
28 instance. 
29 <BR><B>Callback</B> -   Pointer to the callback function for 
30 receiving asynchronous events. 
31 <BR><B>Cookie</B> -   Pointer to user data returned with the 
32 callback function when invoked. 
33 <BR><B>Hnd</B> -   Pointer to a variable to store the 
34 new device handle. <BR><DT><B>Returns:</B><DD>  [int] An integer representing one of the following:
35 <UL>
36 <LI> <TT>UPNP_E_SUCCESS</TT>: The operation completed successfully.
37 <LI> <TT>UPNP_E_FINISH</TT>: The SDK is already terminated or 
38 is not initialized. 
39 <LI> <TT>UPNP_E_INVALID_DESC</TT>: The description document was not 
40 a valid device description.
41 <LI> <TT>UPNP_E_INVALID_URL</TT>: The URL for the description document 
42 is not valid.
43 <LI> <TT>UPNP_E_INVALID_PARAM</TT>: Either <B>Callback</B> or <B>Hnd</B> 
44 is not a valid pointer or <B>DescURL</B> is <TT>NULL</TT>.
45 <LI> <TT>UPNP_E_NETWORK_ERROR</TT>: A network error occurred.
46 <LI> <TT>UPNP_E_SOCKET_WRITE</TT>: An error or timeout occurred writing 
47 to a socket.
48 <LI> <TT>UPNP_E_SOCKET_READ</TT>: An error or timeout occurred reading 
49 from a socket.
50 <LI> <TT>UPNP_E_SOCKET_BIND</TT>: An error occurred binding a socket.
51 <LI> <TT>UPNP_E_SOCKET_CONNECT</TT>: An error occurred connecting the 
52 socket.
53 <LI> <TT>UPNP_E_OUTOF_SOCKET</TT>: Too many sockets are currently 
54 allocated.
55 <LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: There are insufficient resources to 
56 register this root device.
57 </UL> 
58 <BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
59 <BR>
60 This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
61 </BODY>
62 </HTML>