libUPnP  1.14.5
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 
33 #ifndef UPNP_TOOLS_H
34 #define UPNP_TOOLS_H
35 
36 
52 #include "ixml.h" /* for IXML_Document */
53 #include "upnpconfig.h" /* for UPNP_HAVE_TOOLS */
54 
55 
56 /* Function declarations only if tools compiled into the library */
57 #if UPNP_HAVE_TOOLS
58 
59 
60 #ifdef __cplusplus
61 extern "C" {
62 #endif
63 
64 
74  int errorcode);
75 
76 
93  const char *BaseURL,
95  const char *RelURL,
97  char *AbsURL);
98 
99 
116  const char *BaseURL,
118  const char *RelURL,
121  char **AbsURL);
122 
123 
139  const char *ActionName,
141  const char *ServType,
143  int NumArg,
145  const char *Arg,
147  ...);
148 
149 
165  const char *ActionName,
167  const char *ServType,
169  int NumArg,
171  const char *Arg,
173  ...);
174 
175 
195  IXML_Document **ActionDoc,
197  const char *ActionName,
199  const char *ServType,
201  const char *ArgName,
203  const char *ArgVal);
204 
205 
226  IXML_Document **ActionResponse,
228  const char *ActionName,
230  const char *ServType,
232  const char *ArgName,
234  const char *ArgVal);
235 
236 
247  int NumArg,
249  const char *Arg,
251  ...);
252 
253 
271  IXML_Document **PropSet,
273  const char *ArgName,
275  const char *ArgVal);
276 
277 
278 #ifdef __cplusplus
279 }
280 #endif
281 
282 
286 #endif /* UPNP_HAVE_TOOLS */
287 
288 
289 #endif /* UPNP_TOOLS_H */
290 
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:146
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:389
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:170
EXPORT_SPEC IXML_Document * UpnpCreatePropertySet(int NumArg, const char *Arg,...)
Creates a property set message packet.
Definition: upnptools.c:411
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:371
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:128
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:353
Data structure representing the DOM Document.
Definition: ixml.h:159
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:460
#define EXPORT_SPEC
Export functions on WIN32 DLLs.
Definition: UpnpGlobal.h:91
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:400