libUPnP  1.8.0
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 
54 
55 /* Function declarations only if tools compiled into the library */
56 #if UPNP_HAVE_TOOLS
57 
58 
59 #ifdef __cplusplus
60 extern "C" {
61 #endif
62 
63 
73  int errorcode);
74 
75 
92  const char *BaseURL,
94  const char *RelURL,
96  char *AbsURL);
97 
98 
114  const char *ActionName,
116  const char *ServType,
118  int NumArg,
120  const char *Arg,
122  ...);
123 
124 
140  const char *ActionName,
142  const char *ServType,
144  int NumArg,
146  const char *Arg,
148  ...);
149 
150 
170  IXML_Document **ActionDoc,
172  const char *ActionName,
174  const char *ServType,
176  const char *ArgName,
178  const char *ArgVal);
179 
180 
201  IXML_Document **ActionResponse,
203  const char *ActionName,
205  const char *ServType,
207  const char *ArgName,
209  const char *ArgVal);
210 
211 
222  int NumArg,
224  const char *Arg,
226  ...);
227 
228 
246  IXML_Document **PropSet,
248  const char *ArgName,
250  const char *ArgVal);
251 
252 
253 #ifdef __cplusplus
254 }
255 #endif
256 
257 
261 #endif /* UPNP_HAVE_TOOLS */
262 
263 
264 #endif /* UPNP_TOOLS_H */
265 
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:142
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:343
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:372
IXML_Document * UpnpCreatePropertySet(int NumArg, const char *Arg,...)
Creates a property set message packet.
Definition: upnptools.c:383
Data structure representing the DOM Document.
Definition: ixml.h:183
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:123
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:432
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:361
#define EXPORT_SPEC
Export functions on WIN32 DLLs.
Definition: UpnpGlobal.h:82
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:325