libUPnP  1.14.20
upnptools.h
Go to the documentation of this file.
1 /*******************************************************************************
2  *
3  * Copyright (c) 2000-2003 Intel Corporation
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * * Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * * Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  * * Neither name of Intel Corporation nor the names of its contributors
15  * may be used to endorse or promote products derived from this software
16  * without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
22  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
25  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
26  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
27  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  ******************************************************************************/
31 
32 #ifndef UPNP_TOOLS_H
33 #define UPNP_TOOLS_H
34 
49 #include "ixml.h" /* for IXML_Document */
50 #include "upnpconfig.h" /* for UPNP_HAVE_TOOLS */
51 
52 /* Function declarations only if tools compiled into the library */
53 #if UPNP_HAVE_TOOLS
54 
55  #ifdef __cplusplus
56 extern "C" {
57  #endif
58 
65 
75  int errorcode);
76 
93  const char *BaseURL,
95  const char *RelURL,
97  char *AbsURL);
98 
115  const char *BaseURL,
117  const char *RelURL,
120  char **AbsURL);
121 
137  const char *ActionName,
139  const char *ServType,
141  int NumArg,
143  const char *Arg,
145  ...);
146 
162  const char *ActionName,
164  const char *ServType,
166  int NumArg,
168  const char *Arg,
170  ...);
171 
191  IXML_Document **ActionDoc,
193  const char *ActionName,
195  const char *ServType,
197  const char *ArgName,
199  const char *ArgVal);
200 
221  IXML_Document **ActionResponse,
223  const char *ActionName,
225  const char *ServType,
227  const char *ArgName,
229  const char *ArgVal);
230 
241  int NumArg,
243  const char *Arg,
245  ...);
246 
265  IXML_Document **PropSet,
267  const char *ArgName,
269  const char *ArgVal);
270 
271  #ifdef __cplusplus
272 }
273  #endif
274 
277 #endif /* UPNP_HAVE_TOOLS */
278 
279 #endif /* UPNP_TOOLS_H */
#define UPNP_EXPORT_SPEC
Export functions on WIN32 DLLs.
Definition: UpnpGlobal.h:105
UPNP_EXPORT_SPEC int UpnpAddToActionResponse(IXML_Document **ActionResponse, const char *ActionName, const char *ServType, const char *ArgName, const char *ArgVal)
Creates an action response packet based on its output parameters (status variable name and value pair...
Definition: upnptools.c:393
UPNP_EXPORT_SPEC const char * UpnpGetErrorMessage(int errorcode)
Converts an SDK error code into a string error message suitable for display. The memory returned from...
Definition: upnptools.c:117
UPNP_EXPORT_SPEC IXML_Document * UpnpMakeAction(const char *ActionName, const char *ServType, int NumArg, const char *Arg,...)
Creates an action request packet based on its input parameters (status variable name and value pair).
Definition: upnptools.c:351
UPNP_EXPORT_SPEC IXML_Document * UpnpCreatePropertySet(int NumArg, const char *Arg,...)
Creates a property set message packet.
Definition: upnptools.c:403
UPNP_EXPORT_SPEC int UpnpResolveURL(const char *BaseURL, const char *RelURL, char *AbsURL)
Combines a base URL and a relative URL into a single absolute URL.
Definition: upnptools.c:137
UPNP_EXPORT_SPEC int UpnpResolveURL2(const char *BaseURL, const char *RelURL, char **AbsURL)
Combines a base URL and a relative URL into a single absolute URL.
Definition: upnptools.c:157
UPNP_EXPORT_SPEC int UpnpAddToAction(IXML_Document **ActionDoc, const char *ActionName, const char *ServType, const char *ArgName, const char *ArgVal)
Adds the argument in the action request.
Definition: upnptools.c:383
UPNP_EXPORT_SPEC void UpnpSetMaxJobsTotal(int mjt)
Sets the maximum number of jobs in the internal thread pool. This option is intended for server appli...
Definition: upnptools.c:130
UPNP_EXPORT_SPEC IXML_Document * UpnpMakeActionResponse(const char *ActionName, const char *ServType, int NumArg, const char *Arg,...)
Ceates an action response packet based on its output parameters (status variable name and value pair)...
Definition: upnptools.c:367
UPNP_EXPORT_SPEC int UpnpAddToPropertySet(IXML_Document **PropSet, const char *ArgName, const char *ArgVal)
Can be used when an application needs to transfer the status of many variables at once.
Definition: upnptools.c:450
Data structure representing the DOM Document.
Definition: ixml.h:160