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 / UpnpInit.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <HTML>
4 <HEAD>
5    <TITLE>EXPORT_SPEC int UpnpInit</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">UpnpInit</A></H2><H2>( IN const char* HostIP,<BR>&nbsp;  IN unsigned short DestPort )</H2><BLOCKQUOTE>Initializes the Linux SDK for UPnP Devices.</BLOCKQUOTE>
11
12 <A NAME="DOC.DOCU"></A>
13 <HR>
14 <H2>Documentation</H2>
15 <BLOCKQUOTE>Initializes the Linux SDK for UPnP Devices. This function must be called
16 before any other API function can be called.  It should be called
17 only once.  Subsequent calls to this API return a <TT>UPNP_E_INIT</TT>
18 error code.
19
20 <P>Optionally, the application can specify a host IP address (in the
21 case of a multi-homed configuration) and a port number to use for
22 all UPnP operations.  Since a port number can be used only by one
23 process, multiple processes using the SDK must specify
24 different port numbers.
25
26 <P>If unspecified, the SDK will use the first adapter's IP address 
27 and an arbitrary port.
28
29 <P>This call is synchronous.
30
31 <P></BLOCKQUOTE>
32 <DL><DT><DT><B>Parameters:</B><DD><B>HostIP</B> -   The host IP address to use, in 
33 string format, for example "192.168.0.1", 
34 or <TT>NULL</TT> to use the first adapter's 
35 IP address. 
36 <BR><B>DestPort</B> -   The destination port number to use.  0 
37 will pick an arbitrary free port. <BR><DT><B>Returns:</B><DD>  [int] An integer representing one of the following:
38 <UL>
39 <LI> <TT>UPNP_E_SUCCESS</TT>: The operation completed successfully.
40 <LI> <TT>UPNP_E_OUTOF_MEMORY</TT>: Insufficient resources exist 
41 to initialize the SDK.
42 <LI> <TT>UPNP_E_INIT</TT>: The SDK is already initialized. 
43 <LI> <TT>UPNP_E_INIT_FAILED</TT>: The SDK initialization 
44 failed for an unknown reason.
45 <LI> <TT>UPNP_E_SOCKET_BIND</TT>: An error occurred binding a socket.
46 <LI> <TT>UPNP_E_LISTEN</TT>: An error occurred listening to a socket.
47 <LI> <TT>UPNP_E_OUTOF_SOCKET</TT>: An error ocurred creating a socket.
48 <LI> <TT>UPNP_E_INTERNAL_ERROR</TT>: An internal error ocurred.
49 </UL> 
50 <BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
51 <BR>
52 This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
53 </BODY>
54 </HTML>