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 / UpnpSearchAsync.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <HTML>
4 <HEAD>
5    <TITLE>EXPORT_SPEC int UpnpSearchAsync</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">UpnpSearchAsync</A></H2><H2>( IN <!1><A HREF="UpnpClient_Handle.html">UpnpClient_Handle</A> Hnd,<BR>&nbsp;  IN int Mx,<BR>&nbsp;  IN const char* Target,<BR>&nbsp;  IN const void* Cookie )</H2><BLOCKQUOTE><B>UpnpSearchAsync</B> searches for devices matching the given search target.</BLOCKQUOTE>
11
12 <A NAME="DOC.DOCU"></A>
13 <HR>
14 <H2>Documentation</H2>
15 <BLOCKQUOTE><B>UpnpSearchAsync</B> searches for devices matching the given
16 search target.  The function returns immediately and the SDK 
17 calls the default callback function, registered during the 
18 <B>UpnpRegisterClient</B> call, for each matching root device,
19 device, or service.  The application specifies the search type by the 
20 <B>Target</B> parameter.  
21
22 <P>Note that there is no way for the SDK to distinguish which client
23 instance issued a particular search.  Therefore, the client can get
24 search callbacks that do not match the original criteria of the search.
25 Also, the application will receive multiple callbacks for each search.
26
27 <P></BLOCKQUOTE>
28 <DL><DT><DT><B>Parameters:</B><DD><B>Hnd</B> -   The handle of the client performing 
29 the search. 
30 <BR><B>Mx</B> -   The time, in seconds, to wait for 
31 responses. If the time is greater 
32 than <TT>MAX_SEARCH_TIME</TT> then the time is 
33 set to <TT>MAX_SEARCH_TIME</TT>. If the time is 
34 less than <TT>MIN_SEARCH_TIME</TT> then the 
35 time is set to <TT>MIN_SEARCH_TIME</TT>. 
36 <BR><B>Target</B> -   The search target as defined in the UPnP 
37 Device Architecture v1.0 specification. 
38 <BR><B>Cookie</B> -   The user data to pass when the callback 
39 function is invoked. <BR><DT><B>Returns:</B><DD>  [int] An integer representing one of the following:
40 <UL>
41 <LI> <TT>UPNP_E_SUCCESS</TT>: The operation completed successfully.
42 <LI> <TT>UPNP_E_INVALID_HANDLE</TT>: The handle is not a valid control 
43 point handle.
44 <LI> <TT>UPNP_E_INVALID_PARAM</TT>: <B>Target</B> is <TT>NULL</TT>.
45 </UL> 
46 <BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I></P><HR>
47 <BR>
48 This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
49 </BODY>
50 </HTML>