upnptools.h

Go to the documentation of this file.

//
// Copyright (c) 2000-2003 Intel Corporation 
// All rights reserved. 
//
// Redistribution and use in source and binary forms, with or without 
// modification, are permitted provided that the following conditions are met: 
//
// * Redistributions of source code must retain the above copyright notice, 
// this list of conditions and the following disclaimer. 
// * Redistributions in binary form must reproduce the above copyright notice, 
// this list of conditions and the following disclaimer in the documentation 
// and/or other materials provided with the distribution. 
// * Neither name of Intel Corporation nor the names of its contributors 
// may be used to endorse or promote products derived from this software 
// without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR 
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//


#ifndef UPNP_TOOLS_H
#define UPNP_TOOLS_H

#include "upnp.h"

// Function declarations only if tools compiled into the library
#if UPNP_HAVE_TOOLS

#ifdef __cplusplus
extern "C" {
#endif

EXPORT_SPEC int UpnpResolveURL(
    IN const char * BaseURL,  
    IN const char * RelURL,   
    OUT char * AbsURL   
    );

EXPORT_SPEC IXML_Document* UpnpMakeAction(
    IN const char * ActionName, 
    IN const char * ServType,   
    IN int NumArg,              
    IN const char * Arg,        
    IN ...                   /*  Other status variable name and value pairs. */
    );

EXPORT_SPEC int UpnpAddToAction(
        IN OUT IXML_Document ** ActionDoc, 
        IN const char * ActionName,   
        IN const char * ServType,     
        IN const char * ArgName,      
        IN const char * ArgVal        
        );

EXPORT_SPEC IXML_Document* UpnpMakeActionResponse(
    IN const char * ActionName, 
    IN const char * ServType,   
    IN int NumArg,              
    IN const char * Arg,        
    IN ...                   /*  Other status variable name and value pairs. */
    );

EXPORT_SPEC int UpnpAddToActionResponse(
        IN OUT IXML_Document ** ActionResponse, 
        IN const char * ActionName,        
        IN const char * ServType,          
        IN const char * ArgName,           
        IN const char * ArgVal             
        );

EXPORT_SPEC int UpnpAddToPropertySet(
    IN OUT IXML_Document **PropSet,    
    IN const char * ArgName,      
    IN const char * ArgVal        
    );

EXPORT_SPEC IXML_Document* UpnpCreatePropertySet(
    IN int NumArg,        
    IN const char* Arg,   
    IN ...
    );

EXPORT_SPEC const char * UpnpGetErrorMessage(
        int errorcode  
        );


#ifdef __cplusplus
}
#endif

#endif // UPNP_HAVE_TOOLS

#endif // UPNP_TOOLS_H

---