diff --git a/ChangeLog b/ChangeLog index 1d65171..5f3db5e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,14 @@ +2006-07-07 Oxy + + * full support for Windows added, static library and DLL are fully + working, code compiles with Borland Builder C++ and MS Visual + C/C++ + +2006-07-05 Nektarios K. Papadopoulos + + * Include prebuilt documentation (html,pdf), dropping doc++ + dependancy. + 2006-07-03 Marcelo Jimenez * Patch for FreeBSD, thanks to Markus Strobl. @@ -11,11 +22,6 @@ * Fix for va_list initialization in x86_64 architectures. -2006-06-12 Oxy - - * Windows support added, it compiles and exports DLL-symbols but - it is not fully tested yet - 2006-06-08 Oxy * Patch to fix memory leaks and reasons for crashes added (thanks diff --git a/Makefile.am b/Makefile.am index 5a85a4f..f1713da 100644 --- a/Makefile.am +++ b/Makefile.am @@ -9,7 +9,7 @@ ACLOCAL_AMFLAGS = -I m4 DISTCHECK_CONFIGURE_FLAGS = --enable-debug --enable-samples -SUBDIRS = ixml threadutil upnp +SUBDIRS = ixml threadutil upnp docs/dist EXTRA_DIST = libupnp.pc.in LICENSE THANKS diff --git a/THANKS b/THANKS index 9f0e451..9f4511e 100644 --- a/THANKS +++ b/THANKS @@ -6,8 +6,15 @@ suggesting various improvements or submitting actual code. Here is a list of these people. Help us keep it complete and exempt of errors. -Patches: Loigu, Arno Willig, Oskar Liljeblad, Chaos, - Nektarios K. Papadopoulos, John Dennis, Jiri Zouhar, - Marcelo Jimenez -Solaris Port: Oxy -Hints and useful bugreports: Siva Chandran +- Markus Strobl +- Loigu +- Arno Willig +- Oskar Liljeblad +- Chaos +- Nektarios K. Papadopoulos +- John Dennis +- Jiri Zouhar +- Marcelo Jimenez +- Oxy +- Siva Chandran + diff --git a/build/inc/config.h b/build/inc/config.h index e8f0795..b4118a5 100644 --- a/build/inc/config.h +++ b/build/inc/config.h @@ -294,7 +294,7 @@ /** @name DBGONLY - The {\bf DBGONLY} macro allows code to be marked so that it + The {\bf DBGONLY} macro allows code to be marked so that it is only included in the DEBUG build and not the release. To use this macro, put the code inside of the parentheses: @@ -305,55 +305,53 @@ */ //@{ -#ifndef WIN32 - #ifdef DEBUG - # define DBGONLY(x) x - #else - # define DBGONLY(x) - #endif -#endif +#ifdef DEBUG + #define DBGONLY(x) x +#else + #define DBGONLY(x) +#endif //@} -#undef EXCLUDE_WEB_SERVER -#undef EXCLUDE_MINISERVER +#undef EXCLUDE_WEB_SERVER +#undef EXCLUDE_MINISERVER #ifdef INTERNAL_WEB_SERVER -# define EXCLUDE_WEB_SERVER 0 -# define EXCLUDE_MINISERVER 0 + #define EXCLUDE_WEB_SERVER 0 + #define EXCLUDE_MINISERVER 0 #else -# define EXCLUDE_WEB_SERVER 1 -# define EXCLUDE_MINISERVER 1 + #define EXCLUDE_WEB_SERVER 1 + #define EXCLUDE_MINISERVER 1 #endif #if EXCLUDE_GENA == 1 && EXCLUDE_SOAP == 1 && EXCLUDE_WEB_SERVER == 1 -# undef EXCLUDE_MINISERVER -# define EXCLUDE_MINISERVER 1 -# if INTERNAL_WEB_SERVER -# error "conflicting settings: use configure --disable-webserver" -# endif + #undef EXCLUDE_MINISERVER + #define EXCLUDE_MINISERVER 1 + #if INTERNAL_WEB_SERVER + # error "conflicting settings: use configure --disable-webserver" + #endif #endif #if EXCLUDE_GENA == 0 || EXCLUDE_SOAP == 0 || EXCLUDE_WEB_SERVER == 0 -# undef EXCLUDE_MINISERVER -# define EXCLUDE_MINISERVER 0 -# if EXCLUDE_WEB_SERVER == 0 && !defined INTERNAL_WEB_SERVER -# error "conflicting settings : use configure --enable-webserver" -# endif + #undef EXCLUDE_MINISERVER + #define EXCLUDE_MINISERVER 0 + #if EXCLUDE_WEB_SERVER == 0 && !defined INTERNAL_WEB_SERVER + #error "conflicting settings : use configure --enable-webserver" + #endif #endif #ifdef INCLUDE_CLIENT_APIS -# define CLIENTONLY(x) x -#else -# define CLIENTONLY(x) + #define CLIENTONLY(x) x +#else + #define CLIENTONLY(x) #endif #ifdef INCLUDE_DEVICE_APIS -# define DEVICEONLY(x) x -#else -# define DEVICEONLY(x) + #define DEVICEONLY(x) x +#else + #define DEVICEONLY(x) #endif //@} diff --git a/build/libupnp.bpf b/build/libupnp.bpf new file mode 100644 index 0000000..5b12438 --- /dev/null +++ b/build/libupnp.bpf @@ -0,0 +1,50 @@ +USEUNIT("..\ixml\src\nodeList.c"); +USEUNIT("..\ixml\src\attr.c"); +USEUNIT("..\ixml\src\document.c"); +USEUNIT("..\ixml\src\element.c"); +USEUNIT("..\ixml\src\ixml.c"); +USEUNIT("..\ixml\src\ixmlmembuf.c"); +USEUNIT("..\ixml\src\ixmlparser.c"); +USEUNIT("..\ixml\src\namedNodeMap.c"); +USEUNIT("..\ixml\src\node.c"); +USEUNIT("..\threadutil\src\TimerThread.c"); +USEUNIT("..\threadutil\src\FreeList.c"); +USEUNIT("..\threadutil\src\iasnprintf.c"); +USEUNIT("..\threadutil\src\LinkedList.c"); +USEUNIT("..\threadutil\src\ThreadPool.c"); +USEUNIT("..\upnp\src\win_dll.c"); +USEUNIT("..\upnp\src\inet_pton.c"); +USEUNIT("..\upnp\src\api\upnptools.c"); +USEUNIT("..\upnp\src\api\upnpapi.c"); +USEUNIT("..\upnp\src\gena\gena_device.c"); +USEUNIT("..\upnp\src\gena\gena_callback2.c"); +USEUNIT("..\upnp\src\gena\gena_ctrlpt.c"); +USEUNIT("..\upnp\src\genlib\client_table\client_table.c"); +USEUNIT("..\upnp\src\genlib\miniserver\miniserver.c"); +USEUNIT("..\upnp\src\genlib\net\sock.c"); +USEUNIT("..\upnp\src\genlib\net\http\webserver.c"); +USEUNIT("..\upnp\src\genlib\net\http\httpparser.c"); +USEUNIT("..\upnp\src\genlib\net\http\httpreadwrite.c"); +USEUNIT("..\upnp\src\genlib\net\http\parsetools.c"); +USEUNIT("..\upnp\src\genlib\net\http\statcodes.c"); +USEUNIT("..\upnp\src\genlib\net\uri\uri.c"); +USEUNIT("..\upnp\src\genlib\service_table\service_table.c"); +USEUNIT("..\upnp\src\genlib\util\util.c"); +USEUNIT("..\upnp\src\genlib\util\membuffer.c"); +USEUNIT("..\upnp\src\genlib\util\strintmap.c"); +USEUNIT("..\upnp\src\genlib\util\upnp_timeout.c"); +USEUNIT("..\upnp\src\soap\soap_device.c"); +USEUNIT("..\upnp\src\soap\soap_common.c"); +USEUNIT("..\upnp\src\soap\soap_ctrlpt.c"); +USEUNIT("..\upnp\src\ssdp\ssdp_server.c"); +USEUNIT("..\upnp\src\ssdp\ssdp_ctrlpt.c"); +USEUNIT("..\upnp\src\ssdp\ssdp_device.c"); +USEUNIT("..\upnp\src\urlconfig\urlconfig.c"); +USEUNIT("..\upnp\src\uuid\uuid.c"); +USEUNIT("..\upnp\src\uuid\md5.c"); +USEUNIT("..\upnp\src\uuid\sysdep.c"); +USELIB("..\..\..\pthreads-w32-1-10-0-release\pthreadBC1.lib"); +//--------------------------------------------------------------------------- +This file is used by the project manager only and should be treated like the project file + + DllEntryPoint \ No newline at end of file diff --git a/build/libupnp.bpr b/build/libupnp.bpr new file mode 100644 index 0000000..06938c1 --- /dev/null +++ b/build/libupnp.bpr @@ -0,0 +1,128 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +[Version Info] +IncludeVerInfo=0 +AutoIncBuild=0 +MajorVer=1 +MinorVer=0 +Release=0 +Build=0 +Debug=0 +PreRelease=0 +Special=0 +Private=0 +DLL=0 +Locale=1031 +CodePage=1252 + +[Version Info Keys] +CompanyName= +FileDescription= +FileVersion=1.0.0.0 +InternalName= +LegalCopyright= +LegalTrademarks= +OriginalFilename= +ProductName= +ProductVersion=1.0.0.0 +Comments= + +[HistoryLists\hlIncludePath] +Count=1 +Item0=..\upnp\src\genlib\util;..\upnp\src;..\upnp\src\uuid;..\upnp\src\urlconfig;..\upnp\src\ssdp;..\upnp\src\soap;..\upnp\src\genlib\service_table;..\upnp\src\genlib\net;..\upnp\src\genlib\net\uri;..\upnp\src\genlib\net\http;..\upnp\src\genlib\miniserver;..\upnp\src\genlib\client_table;..\upnp\src\gena;..\upnp\src\api;..\threadutil\src;..\ixml\src;$(BCB)\include;$(BCB)\include\vcl;..\ixml\inc;..\threadutil\inc;..\upnp\inc;inc;..\ixml\src\inc;..\upnp\src\inc + +[HistoryLists\hlLibraryPath] +Count=1 +Item0=..\upnp\src\uuid;..\upnp\src\urlconfig;..\upnp\src\ssdp;..\upnp\src\soap;..\upnp\src\genlib\util;..\upnp\src\genlib\service_table;..\upnp\src\genlib\net\uri;..\upnp\src\genlib\net\http;..\upnp\src\genlib\net;..\upnp\src\genlib\miniserver;..\upnp\src\genlib\client_table;..\upnp\src\gena;..\upnp\src\api;..\upnp\src;..\threadutil\src;..\ixml\src;$(BCB)\lib\obj;$(BCB)\lib + +[HistoryLists\hlDebugSourcePath] +Count=1 +Item0=$(BCB)\source\vcl + +[HistoryLists\hlConditionals] +Count=3 +Item0=WIN32;LIBUPNP_EXPORTS +Item1=WIN32;EXPORT_SPEC +Item2=WIN32 + +[Debugging] +DebugSourceDirs=$(BCB)\source\vcl + +[Parameters] +RunParams= +HostApplication= +RemoteHost= +RemotePath= +RemoteDebug=0 + +[Compiler] +ShowInfoMsgs=0 +LinkDebugVcl=0 + + \ No newline at end of file diff --git a/build/libupnp.dsp b/build/libupnp.dsp new file mode 100644 index 0000000..d24987b --- /dev/null +++ b/build/libupnp.dsp @@ -0,0 +1,287 @@ +# Microsoft Developer Studio Project File - Name="libupnp" - Package Owner=<4> +# Microsoft Developer Studio Generated Build File, Format Version 6.00 +# ** NICHT BEARBEITEN ** + +# TARGTYPE "Win32 (x86) Dynamic-Link Library" 0x0102 + +CFG=libupnp - Win32 Debug +!MESSAGE Dies ist kein gültiges Makefile. Zum Erstellen dieses Projekts mit NMAKE +!MESSAGE verwenden Sie den Befehl "Makefile exportieren" und führen Sie den Befehl +!MESSAGE +!MESSAGE NMAKE /f "libupnp.mak". +!MESSAGE +!MESSAGE Sie können beim Ausführen von NMAKE eine Konfiguration angeben +!MESSAGE durch Definieren des Makros CFG in der Befehlszeile. Zum Beispiel: +!MESSAGE +!MESSAGE NMAKE /f "libupnp.mak" CFG="libupnp - Win32 Debug" +!MESSAGE +!MESSAGE Für die Konfiguration stehen zur Auswahl: +!MESSAGE +!MESSAGE "libupnp - Win32 Release" (basierend auf "Win32 (x86) Dynamic-Link Library") +!MESSAGE "libupnp - Win32 Debug" (basierend auf "Win32 (x86) Dynamic-Link Library") +!MESSAGE + +# Begin Project +# PROP AllowPerConfigDependencies 0 +# PROP Scc_ProjName "" +# PROP Scc_LocalPath "" +CPP=cl.exe +MTL=midl.exe +RSC=rc.exe + +!IF "$(CFG)" == "libupnp - Win32 Release" + +# PROP BASE Use_MFC 0 +# PROP BASE Use_Debug_Libraries 0 +# PROP BASE Output_Dir "Release" +# PROP BASE Intermediate_Dir "Release" +# PROP BASE Target_Dir "" +# PROP Use_MFC 0 +# PROP Use_Debug_Libraries 0 +# PROP Output_Dir "Release" +# PROP Intermediate_Dir "Release" +# PROP Ignore_Export_Lib 0 +# PROP Target_Dir "" +# ADD BASE CPP /nologo /MT /W3 /GX /O2 /D "WIN32" /D "NDEBUG" /D "_WINDOWS" /D "_MBCS" /D "_USRDLL" /D "LIBUPNP_EXPORTS" /YX /FD /c +# ADD CPP /nologo /MT /W3 /GX /O2 /I "E:\svnupnp\trunk\ixml\src\inc" /I "E:\svnupnp\trunk\ixml\inc" /I "E:\svnupnp\trunk\threadutil\inc" /I "E:\svnupnp\trunk\upnp\inc" /I "E:\svnupnp\trunk\upnp\src\inc" /I "E:\svnupnp\trunk\build\inc" /D "WIN32" /D "NDEBUG" /D "_WINDOWS" /D "_MBCS" /D "_USRDLL" /D "LIBUPNP_EXPORTS" /FR /YX /FD /c +# ADD BASE MTL /nologo /D "NDEBUG" /mktyplib203 /win32 +# ADD MTL /nologo /D "NDEBUG" /mktyplib203 /win32 +# ADD BASE RSC /l 0x407 /d "NDEBUG" +# ADD RSC /l 0x407 /d "NDEBUG" +BSC32=bscmake.exe +# ADD BASE BSC32 /nologo +# ADD BSC32 /nologo +LINK32=link.exe +# ADD BASE LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib odbc32.lib odbccp32.lib /nologo /dll /machine:I386 +# ADD LINK32 kernel32.lib user32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib odbc32.lib odbccp32.lib E:\svnupnp\trunk\libupnp\build\bin\pthreadvc2.lib ws2_32.lib /nologo /dll /machine:I386 + +!ELSEIF "$(CFG)" == "libupnp - Win32 Debug" + +# PROP BASE Use_MFC 0 +# PROP BASE Use_Debug_Libraries 1 +# PROP BASE Output_Dir "Debug" +# PROP BASE Intermediate_Dir "Debug" +# PROP BASE Target_Dir "" +# PROP Use_MFC 0 +# PROP Use_Debug_Libraries 1 +# PROP Output_Dir "Debug" +# PROP Intermediate_Dir "Debug" +# PROP Ignore_Export_Lib 0 +# PROP Target_Dir "" +# ADD BASE CPP /nologo /MTd /W3 /Gm /GX /ZI /Od /D "WIN32" /D "_DEBUG" /D "_WINDOWS" /D "_MBCS" /D "_USRDLL" /D "LIBUPNP_EXPORTS" /YX /FD /GZ /c +# ADD CPP /nologo /MTd /W3 /Gm /GX /ZI /Od /I "E:\svnupnp\trunk\ixml\src\inc" /I "E:\svnupnp\trunk\ixml\inc" /I "E:\svnupnp\trunk\threadutil\inc" /I "E:\svnupnp\trunk\upnp\inc" /I "E:\svnupnp\trunk\upnp\src\inc" /I "E:\svnupnp\trunk\build\inc" /D "WIN32" /D "_WINDOWS" /D "_MBCS" /D "_USRDLL" /D "LIBUPNP_EXPORTS" /FR /YX /FD /GZ /c +# ADD BASE MTL /nologo /D "_DEBUG" /mktyplib203 /win32 +# ADD MTL /nologo /D "_DEBUG" /mktyplib203 /win32 +# ADD BASE RSC /l 0x407 /d "_DEBUG" +# ADD RSC /l 0x407 /d "_DEBUG" +BSC32=bscmake.exe +# ADD BASE BSC32 /nologo +# ADD BSC32 /nologo +LINK32=link.exe +# ADD BASE LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib odbc32.lib odbccp32.lib /nologo /dll /debug /machine:I386 /pdbtype:sept +# ADD LINK32 kernel32.lib user32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib odbc32.lib odbccp32.lib E:\svnupnp\trunk\libupnp\build\bin\pthreadvc2.lib ws2_32.lib /nologo /dll /debug /machine:I386 /pdbtype:sept + +!ENDIF + +# Begin Target + +# Name "libupnp - Win32 Release" +# Name "libupnp - Win32 Debug" +# Begin Group "Quellcodedateien" + +# PROP Default_Filter "cpp;c;cxx;rc;def;r;odl;idl;hpj;bat" +# Begin Source File + +SOURCE=..\ixml\src\attr.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\client_table\client_table.c +# End Source File +# Begin Source File + +SOURCE=..\ixml\src\document.c +# End Source File +# Begin Source File + +SOURCE=..\ixml\src\element.c +# End Source File +# Begin Source File + +SOURCE=..\threadutil\src\FreeList.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\gena\gena_callback2.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\gena\gena_ctrlpt.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\gena\gena_device.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\net\http\httpparser.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\net\http\httpreadwrite.c +# End Source File +# Begin Source File + +SOURCE=..\threadutil\src\iasnprintf.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\inet_pton.c +# End Source File +# Begin Source File + +SOURCE=..\ixml\src\ixml.c +# End Source File +# Begin Source File + +SOURCE=..\ixml\src\ixmlmembuf.c +# End Source File +# Begin Source File + +SOURCE=..\ixml\src\ixmlparser.c +# End Source File +# Begin Source File + +SOURCE=..\threadutil\src\LinkedList.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\uuid\md5.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\util\membuffer.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\miniserver\miniserver.c +# End Source File +# Begin Source File + +SOURCE=..\ixml\src\namedNodeMap.c +# End Source File +# Begin Source File + +SOURCE=..\ixml\src\node.c +# End Source File +# Begin Source File + +SOURCE=..\ixml\src\nodeList.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\net\http\parsetools.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\service_table\service_table.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\soap\soap_common.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\soap\soap_ctrlpt.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\soap\soap_device.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\net\sock.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\ssdp\ssdp_ctrlpt.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\ssdp\ssdp_device.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\ssdp\ssdp_server.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\net\http\statcodes.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\util\strintmap.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\uuid\sysdep.c +# End Source File +# Begin Source File + +SOURCE=..\threadutil\src\ThreadPool.c +# End Source File +# Begin Source File + +SOURCE=..\threadutil\src\TimerThread.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\util\upnp_timeout.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\api\upnpapi.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\api\upnptools.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\net\uri\uri.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\urlconfig\urlconfig.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\util\util.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\uuid\uuid.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\genlib\net\http\webserver.c +# End Source File +# Begin Source File + +SOURCE=..\upnp\src\win_dll.c +# End Source File +# End Group +# Begin Group "Header-Dateien" + +# PROP Default_Filter "h;hpp;hxx;hm;inl" +# End Group +# Begin Group "Ressourcendateien" + +# PROP Default_Filter "ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe" +# End Group +# Begin Source File + +SOURCE=..\..\..\..\libupnp_win32.patch +# End Source File +# End Target +# End Project diff --git a/build/libupnp.dsw b/build/libupnp.dsw new file mode 100644 index 0000000..d0f2c17 --- /dev/null +++ b/build/libupnp.dsw @@ -0,0 +1,29 @@ +Microsoft Developer Studio Workspace File, Format Version 6.00 +# WARNUNG: DIESE ARBEITSBEREICHSDATEI DARF NICHT BEARBEITET ODER GELÖSCHT WERDEN! + +############################################################################### + +Project: "libupnp"=.\libupnp.dsp - Package Owner=<4> + +Package=<5> +{{{ +}}} + +Package=<4> +{{{ +}}} + +############################################################################### + +Global: + +Package=<5> +{{{ +}}} + +Package=<3> +{{{ +}}} + +############################################################################### + diff --git a/configure.ac b/configure.ac index 23f2223..f5738dd 100644 --- a/configure.ac +++ b/configure.ac @@ -10,7 +10,7 @@ AC_PREREQ(2.59) -AC_INIT([libupnp], [1.4.0], [virtual_worlds@gmx.de]) +AC_INIT([libupnp], [1.4.1], [virtual_worlds@gmx.de]) # *Independently* of the above libupnp package version, the libtool version # of the 3 libraries need to be updated whenever there is a change released : # "current:revision:age" (this is NOT the same as the package version), where: @@ -19,9 +19,9 @@ AC_INIT([libupnp], [1.4.0], [virtual_worlds@gmx.de]) # - interfaces added: age++ # - interfaces removed: age=0 # *please update only once, before a formal release, not for each change* -AC_SUBST([LT_VERSION_IXML], [2:1:0]) -AC_SUBST([LT_VERSION_THREADUTIL], [2:1:0]) -AC_SUBST([LT_VERSION_UPNP], [2:1:0]) +AC_SUBST([LT_VERSION_IXML], [2:2:0]) +AC_SUBST([LT_VERSION_THREADUTIL], [2:2:0]) +AC_SUBST([LT_VERSION_UPNP], [2:2:0]) AC_CONFIG_AUX_DIR(config.aux) @@ -129,6 +129,7 @@ AM_PROG_CC_C_O AC_PROG_LIBTOOL AC_PROG_INSTALL AC_PROG_MAKE_SET +AC_PROG_EGREP # @@ -186,6 +187,7 @@ AC_CONFIG_FILES([Makefile threadutil/Makefile upnp/Makefile upnp/doc/Makefile + docs/dist/Makefile libupnp.pc ]) diff --git a/docs/dist/IXML_Programming_Guide.pdf b/docs/dist/IXML_Programming_Guide.pdf new file mode 100644 index 0000000..b1f5e1f Binary files /dev/null and b/docs/dist/IXML_Programming_Guide.pdf differ diff --git a/docs/dist/Makefile.am b/docs/dist/Makefile.am new file mode 100644 index 0000000..a948ba2 --- /dev/null +++ b/docs/dist/Makefile.am @@ -0,0 +1,508 @@ +EXTRA_DIST = ./UPnP_Programming_Guide.pdf \ + ./IXML_Programming_Guide.pdf \ + ./html/upnp/icon1.gif \ + ./html/upnp/icon2.gif \ + ./html/upnp/toc.html \ + ./html/upnp/General.html \ + ./html/upnp/index.html \ + ./html/upnp/Introduction.html \ + ./html/upnp/License.html \ + ./html/upnp/AboutCallbacks.html \ + ./html/upnp/TheAPI.html \ + ./html/upnp/Errorcodes.html \ + ./html/upnp/UPNP_E_SUCCESS0.html \ + ./html/upnp/UPNP_E_INVALID_HANDLE-100.html \ + ./html/upnp/UPNP_E_INVALID_PARAM-101.html \ + ./html/upnp/UPNP_E_OUTOF_HANDLE-102.html \ + ./html/upnp/UPNP_E_OUTOF_MEMORY-104.html \ + ./html/upnp/UPNP_E_INIT-105.html \ + ./html/upnp/UPNP_E_INVALID_DESC-107.html \ + ./html/upnp/UPNP_E_INVALID_URL-108.html \ + ./html/upnp/UPNP_E_INVALID_SERVICE-111.html \ + ./html/upnp/UPNP_E_BAD_RESPONSE-113.html \ + ./html/upnp/UPNP_E_INVALID_ACTION-115.html \ + ./html/upnp/UPNP_E_FINISH-116.html \ + ./html/upnp/UPNP_E_INIT_FAILED-117.html \ + ./html/upnp/UPNP_E_BAD_HTTPMSG-119.html \ + ./html/upnp/UPNP_E_ALREADY_REGISTERED-120.html \ + ./html/upnp/UPNP_E_NETWORK_ERROR-200.html \ + ./html/upnp/UPNP_E_SOCKET_WRITE-201.html \ + ./html/upnp/UPNP_E_SOCKET_READ-202.html \ + ./html/upnp/UPNP_E_SOCKET_BIND-203.html \ + ./html/upnp/UPNP_E_SOCKET_CONNECT-204.html \ + ./html/upnp/UPNP_E_OUTOF_SOCKET-205.html \ + ./html/upnp/UPNP_E_LISTEN-206.html \ + ./html/upnp/UPNP_E_TIMEDOUT-207.html \ + ./html/upnp/UPNP_E_SOCKET_ERROR-208.html \ + ./html/upnp/UPNP_E_CANCELED-210.html \ + ./html/upnp/UPNP_E_SUBSCRIBE_UNACCEPTED-301.html \ + ./html/upnp/UPNP_E_UNSUBSCRIBE_UNACCAPTED-302.html \ + ./html/upnp/UPNP_E_NOTIFY_UNACCEPTED-303.html \ + ./html/upnp/UPNP_E_INVALID_ARGUMENT-501.html \ + ./html/upnp/UPNP_E_FILE_NOT_FOUND-502.html \ + ./html/upnp/UPNP_E_FILE_READ_ERROR-503.html \ + ./html/upnp/UPNP_E_EXT_NOT_XML-504.html \ + ./html/upnp/UPNP_E_NOT_FOUND-507.html \ + ./html/upnp/UPNP_E_INTERNAL_ERROR-911.html \ + ./html/upnp/ConstantsStructuresandTypes.html \ + ./html/upnp/UpnpClient_Handle.html \ + ./html/upnp/UpnpDevice_Handle.html \ + ./html/upnp/UPnP_EventType.html \ + ./html/upnp/UPNP_CONTROL_ACTION_REQUEST.html \ + ./html/upnp/UPNP_CONTROL_ACTION_COMPLETE.html \ + ./html/upnp/UPNP_CONTROL_GET_VAR_REQUEST.html \ + ./html/upnp/UPNP_CONTROL_GET_VAR_COMPLETE.html \ + ./html/upnp/UPNP_DISCOVERY_ADVERTISEMENT_ALIVE.html \ + ./html/upnp/UPNP_DISCOVERY_ADVERTISEMENT_BYEBYE.html \ + ./html/upnp/UPNP_DISCOVERY_SEARCH_RESULT.html \ + ./html/upnp/UPNP_DISCOVERY_SEARCH_TIMEOUT.html \ + ./html/upnp/UPNP_EVENT_SUBSCRIPTION_REQUEST.html \ + ./html/upnp/UPNP_EVENT_RECEIVED.html \ + ./html/upnp/UPNP_EVENT_RENEWAL_COMPLETE.html \ + ./html/upnp/UPNP_EVENT_SUBSCRIBE_COMPLETE.html \ + ./html/upnp/UPNP_EVENT_UNSUBSCRIBE_COMPLETE.html \ + ./html/upnp/UPNP_EVENT_AUTORENEWAL_FAILED.html \ + ./html/upnp/UPNP_EVENT_SUBSCRIPTION_EXPIRED.html \ + ./html/upnp/Upnp_SID44.html \ + ./html/upnp/Upnp_SType.html \ + ./html/upnp/UPNP_S_ALL.html \ + ./html/upnp/UPNP_S_ROOT.html \ + ./html/upnp/UPNP_S_DEVICE.html \ + ./html/upnp/UPNP_S_SERVICE.html \ + ./html/upnp/Upnp_DescType.html \ + ./html/upnp/UPNPREG_URL_DESC.html \ + ./html/upnp/UPNPREG_FILENAME_DESC.html \ + ./html/upnp/UPNPREG_BUF_DESC.html \ + ./html/upnp/Upnp_Action_Request.html \ + ./html/upnp/Upnp_State_Var_Request.html \ + ./html/upnp/Upnp_State_Var_Complete.html \ + ./html/upnp/Upnp_Event.html \ + ./html/upnp/Upnp_Discovery.html \ + ./html/upnp/Upnp_Event_Subscribe.html \ + ./html/upnp/Upnp_Subscription_Request.html \ + ./html/upnp/UpnpVirtualDirCallbacks.html \ + ./html/upnp/Upnp_FunPtr.html \ + ./html/upnp/InitializationandRegistration.html \ + ./html/upnp/UpnpInit.html \ + ./html/upnp/UpnpFinish.html \ + ./html/upnp/UpnpGetServerPort.html \ + ./html/upnp/UpnpGetServerIpAddress.html \ + ./html/upnp/UpnpRegisterClient.html \ + ./html/upnp/UpnpRegisterRootDevice.html \ + ./html/upnp/UpnpRegisterRootDevice2.html \ + ./html/upnp/UpnpUnRegisterClient.html \ + ./html/upnp/UpnpUnRegisterRootDevice.html \ + ./html/upnp/UpnpSetContentLength.html \ + ./html/upnp/UpnpSetMaxContentLength.html \ + ./html/upnp/Discovery.html \ + ./html/upnp/UpnpSearchAsync.html \ + ./html/upnp/UpnpSendAdvertisement.html \ + ./html/upnp/Control.html \ + ./html/upnp/UpnpGetServiceVarStatus.html \ + ./html/upnp/UpnpGetServiceVarStatusAsync.html \ + ./html/upnp/UpnpSendAction.html \ + ./html/upnp/UpnpSendActionEx.html \ + ./html/upnp/UpnpSendActionAsync.html \ + ./html/upnp/UpnpSendActionExAsync.html \ + ./html/upnp/Eventing.html \ + ./html/upnp/UpnpAcceptSubscription.html \ + ./html/upnp/UpnpAcceptSubscriptionExt.html \ + ./html/upnp/UpnpNotify.html \ + ./html/upnp/UpnpNotifyExt.html \ + ./html/upnp/UpnpRenewSubscription.html \ + ./html/upnp/UpnpRenewSubscriptionAsync.html \ + ./html/upnp/UpnpSetMaxSubscriptions.html \ + ./html/upnp/UpnpSetMaxSubscriptionTimeOut.html \ + ./html/upnp/UpnpSubscribe.html \ + ./html/upnp/UpnpSubscribeAsync.html \ + ./html/upnp/UpnpUnSubscribe.html \ + ./html/upnp/UpnpUnSubscribeAsync.html \ + ./html/upnp/ControlPointHTTPAPI.html \ + ./html/upnp/UpnpDownloadUrlItem.html \ + ./html/upnp/UpnpOpenHttpGet.html \ + ./html/upnp/UpnpOpenHttpGetProxy.html \ + ./html/upnp/UpnpOpenHttpGetEx.html \ + ./html/upnp/UpnpReadHttpGet.html \ + ./html/upnp/UpnpHttpGetProgress.html \ + ./html/upnp/UpnpCancelHttpGet.html \ + ./html/upnp/UpnpCloseHttpGet.html \ + ./html/upnp/UpnpOpenHttpPost.html \ + ./html/upnp/UpnpWriteHttpPost.html \ + ./html/upnp/UpnpCloseHttpPost.html \ + ./html/upnp/UpnpDownloadXmlDoc.html \ + ./html/upnp/WebServerAPI.html \ + ./html/upnp/UpnpSetWebServerRootDir.html \ + ./html/upnp/UpnpSetVirtualDirCallbacks.html \ + ./html/upnp/UpnpEnableWebserver.html \ + ./html/upnp/UpnpIsWebserverEnabled.html \ + ./html/upnp/UpnpAddVirtualDir.html \ + ./html/upnp/UpnpRemoveVirtualDir.html \ + ./html/upnp/UpnpRemoveAllVirtualDirs.html \ + ./html/upnp/OptionalToolAPIs.html \ + ./html/upnp/UpnpResolveURL.html \ + ./html/upnp/UpnpMakeAction.html \ + ./html/upnp/UpnpAddToAction.html \ + ./html/upnp/UpnpMakeActionResponse.html \ + ./html/upnp/UpnpAddToActionResponse.html \ + ./html/upnp/UpnpAddToPropertySet.html \ + ./html/upnp/UpnpCreatePropertySet.html \ + ./html/upnp/UpnpGetErrorMessage.html \ + ./html/ixml/icon1.gif \ + ./html/ixml/icon2.gif \ + ./html/ixml/toc.html \ + ./html/ixml/General.html \ + ./html/ixml/index.html \ + ./html/ixml/Introduction.html \ + ./html/ixml/License.html \ + ./html/ixml/DOMInterfaces.html \ + ./html/ixml/InterfaceitNode.html \ + ./html/ixml/ixmlNode_getNodeName.html \ + ./html/ixml/ixmlNode_getNodeValue.html \ + ./html/ixml/ixmlNode_setNodeValue.html \ + ./html/ixml/ixmlNode_getNodeType.html \ + ./html/ixml/ixmlNode_getParentNode.html \ + ./html/ixml/ixmlNode_getChildNodes.html \ + ./html/ixml/ixmlNode_getFirstChild.html \ + ./html/ixml/ixmlNode_getLastChild.html \ + ./html/ixml/ixmlNode_getPreviousSibling.html \ + ./html/ixml/ixmlNode_getNextSibling.html \ + ./html/ixml/ixmlNode_getAttributes.html \ + ./html/ixml/ixmlNode_getOwnerDocument.html \ + ./html/ixml/ixmlNode_getNamespaceURI.html \ + ./html/ixml/ixmlNode_getPrefix.html \ + ./html/ixml/ixmlNode_getLocalName.html \ + ./html/ixml/ixmlNode_insertBefore.html \ + ./html/ixml/ixmlNode_replaceChild.html \ + ./html/ixml/ixmlNode_removeChild.html \ + ./html/ixml/ixmlNode_appendChild.html \ + ./html/ixml/ixmlNode_hasChildNodes.html \ + ./html/ixml/ixmlNode_cloneNode.html \ + ./html/ixml/ixmlNode_hasAttributes.html \ + ./html/ixml/ixmlNode_free.html \ + ./html/ixml/InterfaceitAttr.html \ + ./html/ixml/ixmlAttr_free.html \ + ./html/ixml/InterfaceitCDATASection.html \ + ./html/ixml/ixmlCDATASection_init.html \ + ./html/ixml/ixmlCDATASection_free.html \ + ./html/ixml/InterfaceitDocument.html \ + ./html/ixml/ixmlDocument_init.html \ + ./html/ixml/ixmlDocument_createDocumentEx.html \ + ./html/ixml/ixmlDocument_createDocument.html \ + ./html/ixml/ixmlDocument_createElementEx.html \ + ./html/ixml/ixmlDocument_createElement.html \ + ./html/ixml/ixmlDocument_createTextNodeEx.html \ + ./html/ixml/ixmlDocument_createTextNode.html \ + ./html/ixml/ixmlDocument_createCDATASectionEx.html \ + ./html/ixml/ixmlDocument_createCDATASection.html \ + ./html/ixml/ixmlDocument_createAttribute.html \ + ./html/ixml/ixmlDocument_createAttributeEx.html \ + ./html/ixml/ixmlDocument_getElementsByTagName.html \ + ./html/ixml/ixmlDocument_createElementNSEx.html \ + ./html/ixml/ixmlDocument_createElementNS.html \ + ./html/ixml/ixmlDocument_createAttributeNSEx.html \ + ./html/ixml/ixmlDocument_createAttributeNS.html \ + ./html/ixml/ixmlDocument_getElementsByTagNameNS.html \ + ./html/ixml/ixmlDocument_getElementById.html \ + ./html/ixml/ixmlDocument_free.html \ + ./html/ixml/ixmlDocument_importNode.html \ + ./html/ixml/InterfaceitElement.html \ + ./html/ixml/ixmlElement_init.html \ + ./html/ixml/ixmlElement_getTagName.html \ + ./html/ixml/ixmlElement_getAttribute.html \ + ./html/ixml/ixmlElement_setAttribute.html \ + ./html/ixml/ixmlElement_removeAttribute.html \ + ./html/ixml/ixmlElement_getAttributeNode.html \ + ./html/ixml/ixmlElement_setAttributeNode.html \ + ./html/ixml/ixmlElement_removeAttributeNode.html \ + ./html/ixml/ixmlElement_getElementsByTagName.html \ + ./html/ixml/ixmlElement_getAttributeNS.html \ + ./html/ixml/ixmlElement_setAttributeNS.html \ + ./html/ixml/ixmlElement_removeAttributeNS.html \ + ./html/ixml/ixmlElement_getAttributeNodeNS.html \ + ./html/ixml/ixmlElement_setAttributeNodeNS.html \ + ./html/ixml/ixmlElement_getElementsByTagNameNS.html \ + ./html/ixml/ixmlElement_hasAttribute.html \ + ./html/ixml/ixmlElement_hasAttributeNS.html \ + ./html/ixml/ixmlElement_free.html \ + ./html/ixml/InterfaceitNamedNodeMap.html \ + ./html/ixml/ixmlNamedNodeMap_getLength.html \ + ./html/ixml/ixmlNamedNodeMap_getNamedItem.html \ + ./html/ixml/ixmlNamedNodeMap_setNamedItem.html \ + ./html/ixml/ixmlNamedNodeMap_removeNamedItem.html \ + ./html/ixml/ixmlNamedNodeMap_item.html \ + ./html/ixml/ixmlNamedNodeMap_getNamedItemNS.html \ + ./html/ixml/ixmlNamedNodeMap_setNamedItemNS.html \ + ./html/ixml/ixmlNamedNodeMap_removeNamedItemNS.html \ + ./html/ixml/ixmlNamedNodeMap_free.html \ + ./html/ixml/InterfaceitNodeList.html \ + ./html/ixml/ixmlNodeList_item.html \ + ./html/ixml/ixmlNodeList_length.html \ + ./html/ixml/ixmlNodeList_free.html \ + ./html/ixml/IXMLAPI.html \ + ./html/ixml/ixmlPrintDocument.html \ + ./html/ixml/ixmlPrintNode.html \ + ./html/ixml/ixmlDocumenttoString.html \ + ./html/ixml/ixmlNodetoString.html \ + ./html/ixml/ixmlRelaxParser.html \ + ./html/ixml/ixmlParseBuffer.html \ + ./html/ixml/ixmlParseBufferEx.html \ + ./html/ixml/ixmlLoadDocument.html \ + ./html/ixml/ixmlLoadDocumentEx.html \ + ./html/ixml/ixmlCloneDOMString.html \ + ./html/ixml/ixmlFreeDOMString.html + +if WITH_DOCDIR + docsdir = @DOCDIR@ + nobase_docs_DATA = ./UPnP_Programming_Guide.pdf \ + ./IXML_Programming_Guide.pdf \ + ./html/upnp/icon1.gif \ + ./html/upnp/icon2.gif \ + ./html/upnp/toc.html \ + ./html/upnp/General.html \ + ./html/upnp/index.html \ + ./html/upnp/Introduction.html \ + ./html/upnp/License.html \ + ./html/upnp/AboutCallbacks.html \ + ./html/upnp/TheAPI.html \ + ./html/upnp/Errorcodes.html \ + ./html/upnp/UPNP_E_SUCCESS0.html \ + ./html/upnp/UPNP_E_INVALID_HANDLE-100.html \ + ./html/upnp/UPNP_E_INVALID_PARAM-101.html \ + ./html/upnp/UPNP_E_OUTOF_HANDLE-102.html \ + ./html/upnp/UPNP_E_OUTOF_MEMORY-104.html \ + ./html/upnp/UPNP_E_INIT-105.html \ + ./html/upnp/UPNP_E_INVALID_DESC-107.html \ + ./html/upnp/UPNP_E_INVALID_URL-108.html \ + ./html/upnp/UPNP_E_INVALID_SERVICE-111.html \ + ./html/upnp/UPNP_E_BAD_RESPONSE-113.html \ + ./html/upnp/UPNP_E_INVALID_ACTION-115.html \ + ./html/upnp/UPNP_E_FINISH-116.html \ + ./html/upnp/UPNP_E_INIT_FAILED-117.html \ + ./html/upnp/UPNP_E_BAD_HTTPMSG-119.html \ + ./html/upnp/UPNP_E_ALREADY_REGISTERED-120.html \ + ./html/upnp/UPNP_E_NETWORK_ERROR-200.html \ + ./html/upnp/UPNP_E_SOCKET_WRITE-201.html \ + ./html/upnp/UPNP_E_SOCKET_READ-202.html \ + ./html/upnp/UPNP_E_SOCKET_BIND-203.html \ + ./html/upnp/UPNP_E_SOCKET_CONNECT-204.html \ + ./html/upnp/UPNP_E_OUTOF_SOCKET-205.html \ + ./html/upnp/UPNP_E_LISTEN-206.html \ + ./html/upnp/UPNP_E_TIMEDOUT-207.html \ + ./html/upnp/UPNP_E_SOCKET_ERROR-208.html \ + ./html/upnp/UPNP_E_CANCELED-210.html \ + ./html/upnp/UPNP_E_SUBSCRIBE_UNACCEPTED-301.html \ + ./html/upnp/UPNP_E_UNSUBSCRIBE_UNACCAPTED-302.html \ + ./html/upnp/UPNP_E_NOTIFY_UNACCEPTED-303.html \ + ./html/upnp/UPNP_E_INVALID_ARGUMENT-501.html \ + ./html/upnp/UPNP_E_FILE_NOT_FOUND-502.html \ + ./html/upnp/UPNP_E_FILE_READ_ERROR-503.html \ + ./html/upnp/UPNP_E_EXT_NOT_XML-504.html \ + ./html/upnp/UPNP_E_NOT_FOUND-507.html \ + ./html/upnp/UPNP_E_INTERNAL_ERROR-911.html \ + ./html/upnp/ConstantsStructuresandTypes.html \ + ./html/upnp/UpnpClient_Handle.html \ + ./html/upnp/UpnpDevice_Handle.html \ + ./html/upnp/UPnP_EventType.html \ + ./html/upnp/UPNP_CONTROL_ACTION_REQUEST.html \ + ./html/upnp/UPNP_CONTROL_ACTION_COMPLETE.html \ + ./html/upnp/UPNP_CONTROL_GET_VAR_REQUEST.html \ + ./html/upnp/UPNP_CONTROL_GET_VAR_COMPLETE.html \ + ./html/upnp/UPNP_DISCOVERY_ADVERTISEMENT_ALIVE.html \ + ./html/upnp/UPNP_DISCOVERY_ADVERTISEMENT_BYEBYE.html \ + ./html/upnp/UPNP_DISCOVERY_SEARCH_RESULT.html \ + ./html/upnp/UPNP_DISCOVERY_SEARCH_TIMEOUT.html \ + ./html/upnp/UPNP_EVENT_SUBSCRIPTION_REQUEST.html \ + ./html/upnp/UPNP_EVENT_RECEIVED.html \ + ./html/upnp/UPNP_EVENT_RENEWAL_COMPLETE.html \ + ./html/upnp/UPNP_EVENT_SUBSCRIBE_COMPLETE.html \ + ./html/upnp/UPNP_EVENT_UNSUBSCRIBE_COMPLETE.html \ + ./html/upnp/UPNP_EVENT_AUTORENEWAL_FAILED.html \ + ./html/upnp/UPNP_EVENT_SUBSCRIPTION_EXPIRED.html \ + ./html/upnp/Upnp_SID44.html \ + ./html/upnp/Upnp_SType.html \ + ./html/upnp/UPNP_S_ALL.html \ + ./html/upnp/UPNP_S_ROOT.html \ + ./html/upnp/UPNP_S_DEVICE.html \ + ./html/upnp/UPNP_S_SERVICE.html \ + ./html/upnp/Upnp_DescType.html \ + ./html/upnp/UPNPREG_URL_DESC.html \ + ./html/upnp/UPNPREG_FILENAME_DESC.html \ + ./html/upnp/UPNPREG_BUF_DESC.html \ + ./html/upnp/Upnp_Action_Request.html \ + ./html/upnp/Upnp_State_Var_Request.html \ + ./html/upnp/Upnp_State_Var_Complete.html \ + ./html/upnp/Upnp_Event.html \ + ./html/upnp/Upnp_Discovery.html \ + ./html/upnp/Upnp_Event_Subscribe.html \ + ./html/upnp/Upnp_Subscription_Request.html \ + ./html/upnp/UpnpVirtualDirCallbacks.html \ + ./html/upnp/Upnp_FunPtr.html \ + ./html/upnp/InitializationandRegistration.html \ + ./html/upnp/UpnpInit.html \ + ./html/upnp/UpnpFinish.html \ + ./html/upnp/UpnpGetServerPort.html \ + ./html/upnp/UpnpGetServerIpAddress.html \ + ./html/upnp/UpnpRegisterClient.html \ + ./html/upnp/UpnpRegisterRootDevice.html \ + ./html/upnp/UpnpRegisterRootDevice2.html \ + ./html/upnp/UpnpUnRegisterClient.html \ + ./html/upnp/UpnpUnRegisterRootDevice.html \ + ./html/upnp/UpnpSetContentLength.html \ + ./html/upnp/UpnpSetMaxContentLength.html \ + ./html/upnp/Discovery.html \ + ./html/upnp/UpnpSearchAsync.html \ + ./html/upnp/UpnpSendAdvertisement.html \ + ./html/upnp/Control.html \ + ./html/upnp/UpnpGetServiceVarStatus.html \ + ./html/upnp/UpnpGetServiceVarStatusAsync.html \ + ./html/upnp/UpnpSendAction.html \ + ./html/upnp/UpnpSendActionEx.html \ + ./html/upnp/UpnpSendActionAsync.html \ + ./html/upnp/UpnpSendActionExAsync.html \ + ./html/upnp/Eventing.html \ + ./html/upnp/UpnpAcceptSubscription.html \ + ./html/upnp/UpnpAcceptSubscriptionExt.html \ + ./html/upnp/UpnpNotify.html \ + ./html/upnp/UpnpNotifyExt.html \ + ./html/upnp/UpnpRenewSubscription.html \ + ./html/upnp/UpnpRenewSubscriptionAsync.html \ + ./html/upnp/UpnpSetMaxSubscriptions.html \ + ./html/upnp/UpnpSetMaxSubscriptionTimeOut.html \ + ./html/upnp/UpnpSubscribe.html \ + ./html/upnp/UpnpSubscribeAsync.html \ + ./html/upnp/UpnpUnSubscribe.html \ + ./html/upnp/UpnpUnSubscribeAsync.html \ + ./html/upnp/ControlPointHTTPAPI.html \ + ./html/upnp/UpnpDownloadUrlItem.html \ + ./html/upnp/UpnpOpenHttpGet.html \ + ./html/upnp/UpnpOpenHttpGetProxy.html \ + ./html/upnp/UpnpOpenHttpGetEx.html \ + ./html/upnp/UpnpReadHttpGet.html \ + ./html/upnp/UpnpHttpGetProgress.html \ + ./html/upnp/UpnpCancelHttpGet.html \ + ./html/upnp/UpnpCloseHttpGet.html \ + ./html/upnp/UpnpOpenHttpPost.html \ + ./html/upnp/UpnpWriteHttpPost.html \ + ./html/upnp/UpnpCloseHttpPost.html \ + ./html/upnp/UpnpDownloadXmlDoc.html \ + ./html/upnp/WebServerAPI.html \ + ./html/upnp/UpnpSetWebServerRootDir.html \ + ./html/upnp/UpnpSetVirtualDirCallbacks.html \ + ./html/upnp/UpnpEnableWebserver.html \ + ./html/upnp/UpnpIsWebserverEnabled.html \ + ./html/upnp/UpnpAddVirtualDir.html \ + ./html/upnp/UpnpRemoveVirtualDir.html \ + ./html/upnp/UpnpRemoveAllVirtualDirs.html \ + ./html/upnp/OptionalToolAPIs.html \ + ./html/upnp/UpnpResolveURL.html \ + ./html/upnp/UpnpMakeAction.html \ + ./html/upnp/UpnpAddToAction.html \ + ./html/upnp/UpnpMakeActionResponse.html \ + ./html/upnp/UpnpAddToActionResponse.html \ + ./html/upnp/UpnpAddToPropertySet.html \ + ./html/upnp/UpnpCreatePropertySet.html \ + ./html/upnp/UpnpGetErrorMessage.html \ + ./html/ixml/icon1.gif \ + ./html/ixml/icon2.gif \ + ./html/ixml/toc.html \ + ./html/ixml/General.html \ + ./html/ixml/index.html \ + ./html/ixml/Introduction.html \ + ./html/ixml/License.html \ + ./html/ixml/DOMInterfaces.html \ + ./html/ixml/InterfaceitNode.html \ + ./html/ixml/ixmlNode_getNodeName.html \ + ./html/ixml/ixmlNode_getNodeValue.html \ + ./html/ixml/ixmlNode_setNodeValue.html \ + ./html/ixml/ixmlNode_getNodeType.html \ + ./html/ixml/ixmlNode_getParentNode.html \ + ./html/ixml/ixmlNode_getChildNodes.html \ + ./html/ixml/ixmlNode_getFirstChild.html \ + ./html/ixml/ixmlNode_getLastChild.html \ + ./html/ixml/ixmlNode_getPreviousSibling.html \ + ./html/ixml/ixmlNode_getNextSibling.html \ + ./html/ixml/ixmlNode_getAttributes.html \ + ./html/ixml/ixmlNode_getOwnerDocument.html \ + ./html/ixml/ixmlNode_getNamespaceURI.html \ + ./html/ixml/ixmlNode_getPrefix.html \ + ./html/ixml/ixmlNode_getLocalName.html \ + ./html/ixml/ixmlNode_insertBefore.html \ + ./html/ixml/ixmlNode_replaceChild.html \ + ./html/ixml/ixmlNode_removeChild.html \ + ./html/ixml/ixmlNode_appendChild.html \ + ./html/ixml/ixmlNode_hasChildNodes.html \ + ./html/ixml/ixmlNode_cloneNode.html \ + ./html/ixml/ixmlNode_hasAttributes.html \ + ./html/ixml/ixmlNode_free.html \ + ./html/ixml/InterfaceitAttr.html \ + ./html/ixml/ixmlAttr_free.html \ + ./html/ixml/InterfaceitCDATASection.html \ + ./html/ixml/ixmlCDATASection_init.html \ + ./html/ixml/ixmlCDATASection_free.html \ + ./html/ixml/InterfaceitDocument.html \ + ./html/ixml/ixmlDocument_init.html \ + ./html/ixml/ixmlDocument_createDocumentEx.html \ + ./html/ixml/ixmlDocument_createDocument.html \ + ./html/ixml/ixmlDocument_createElementEx.html \ + ./html/ixml/ixmlDocument_createElement.html \ + ./html/ixml/ixmlDocument_createTextNodeEx.html \ + ./html/ixml/ixmlDocument_createTextNode.html \ + ./html/ixml/ixmlDocument_createCDATASectionEx.html \ + ./html/ixml/ixmlDocument_createCDATASection.html \ + ./html/ixml/ixmlDocument_createAttribute.html \ + ./html/ixml/ixmlDocument_createAttributeEx.html \ + ./html/ixml/ixmlDocument_getElementsByTagName.html \ + ./html/ixml/ixmlDocument_createElementNSEx.html \ + ./html/ixml/ixmlDocument_createElementNS.html \ + ./html/ixml/ixmlDocument_createAttributeNSEx.html \ + ./html/ixml/ixmlDocument_createAttributeNS.html \ + ./html/ixml/ixmlDocument_getElementsByTagNameNS.html \ + ./html/ixml/ixmlDocument_getElementById.html \ + ./html/ixml/ixmlDocument_free.html \ + ./html/ixml/ixmlDocument_importNode.html \ + ./html/ixml/InterfaceitElement.html \ + ./html/ixml/ixmlElement_init.html \ + ./html/ixml/ixmlElement_getTagName.html \ + ./html/ixml/ixmlElement_getAttribute.html \ + ./html/ixml/ixmlElement_setAttribute.html \ + ./html/ixml/ixmlElement_removeAttribute.html \ + ./html/ixml/ixmlElement_getAttributeNode.html \ + ./html/ixml/ixmlElement_setAttributeNode.html \ + ./html/ixml/ixmlElement_removeAttributeNode.html \ + ./html/ixml/ixmlElement_getElementsByTagName.html \ + ./html/ixml/ixmlElement_getAttributeNS.html \ + ./html/ixml/ixmlElement_setAttributeNS.html \ + ./html/ixml/ixmlElement_removeAttributeNS.html \ + ./html/ixml/ixmlElement_getAttributeNodeNS.html \ + ./html/ixml/ixmlElement_setAttributeNodeNS.html \ + ./html/ixml/ixmlElement_getElementsByTagNameNS.html \ + ./html/ixml/ixmlElement_hasAttribute.html \ + ./html/ixml/ixmlElement_hasAttributeNS.html \ + ./html/ixml/ixmlElement_free.html \ + ./html/ixml/InterfaceitNamedNodeMap.html \ + ./html/ixml/ixmlNamedNodeMap_getLength.html \ + ./html/ixml/ixmlNamedNodeMap_getNamedItem.html \ + ./html/ixml/ixmlNamedNodeMap_setNamedItem.html \ + ./html/ixml/ixmlNamedNodeMap_removeNamedItem.html \ + ./html/ixml/ixmlNamedNodeMap_item.html \ + ./html/ixml/ixmlNamedNodeMap_getNamedItemNS.html \ + ./html/ixml/ixmlNamedNodeMap_setNamedItemNS.html \ + ./html/ixml/ixmlNamedNodeMap_removeNamedItemNS.html \ + ./html/ixml/ixmlNamedNodeMap_free.html \ + ./html/ixml/InterfaceitNodeList.html \ + ./html/ixml/ixmlNodeList_item.html \ + ./html/ixml/ixmlNodeList_length.html \ + ./html/ixml/ixmlNodeList_free.html \ + ./html/ixml/IXMLAPI.html \ + ./html/ixml/ixmlPrintDocument.html \ + ./html/ixml/ixmlPrintNode.html \ + ./html/ixml/ixmlDocumenttoString.html \ + ./html/ixml/ixmlNodetoString.html \ + ./html/ixml/ixmlRelaxParser.html \ + ./html/ixml/ixmlParseBuffer.html \ + ./html/ixml/ixmlParseBufferEx.html \ + ./html/ixml/ixmlLoadDocument.html \ + ./html/ixml/ixmlLoadDocumentEx.html \ + ./html/ixml/ixmlCloneDOMString.html \ + ./html/ixml/ixmlFreeDOMString.html +endif diff --git a/docs/dist/UPnP_Programming_Guide.pdf b/docs/dist/UPnP_Programming_Guide.pdf new file mode 100644 index 0000000..8e71ee6 Binary files /dev/null and b/docs/dist/UPnP_Programming_Guide.pdf differ diff --git a/docs/dist/html/ixml/DOMInterfaces.html b/docs/dist/html/ixml/DOMInterfaces.html new file mode 100644 index 0000000..df8753a --- /dev/null +++ b/docs/dist/html/ixml/DOMInterfaces.html @@ -0,0 +1,48 @@ + + + + + DOM Interfaces + + + + +

DOM Interfaces

+
The Document Object Model consists of a set of objects and interfaces +for accessing and manipulating documents. IXML does not implement all +the interfaces documented in the DOM2-Core recommendation but defines +a subset of the most useful interfaces. A description of the supported +interfaces and methods is presented in this section. + +

For a complete discussion on the object model, the object hierarchy, +etc., refer to section 1.1 of the DOM2-Core recommendation.

+ +
+
+
+ +o +Interface Node
+ +o +Interface Attr
+ +o +Interface CDATASection
+ +o +Interface Document
+ +o +Interface Element
+ +o +Interface NamedNodeMap
+ +o +Interface NodeList
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/General.html b/docs/dist/html/ixml/General.html new file mode 100644 index 0000000..3dbee59 --- /dev/null +++ b/docs/dist/html/ixml/General.html @@ -0,0 +1,16 @@ + + + + + General Bits + + + + +
+
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/IXMLAPI.html b/docs/dist/html/ixml/IXMLAPI.html new file mode 100644 index 0000000..107ca7a --- /dev/null +++ b/docs/dist/html/ixml/IXMLAPI.html @@ -0,0 +1,67 @@ + + + + + IXML API + + + + +

IXML API

+
The IXML API contains utility functions that are not part of the standard +DOM interfaces. They include functions to create a DOM structure from a +file or buffer, create an XML file from a DOM structure, and manipulate +DOMString objects.
+ +
+
+
+ +o +ixmlPrintDocument
Renders a Node and all sub-elements into an XML document representation. +
+ +o +ixmlPrintNode
Renders a Node and all sub-elements into an XML text representation. +
+ +o +ixmlDocumenttoString
Renders a Node and all sub-elements into an XML document representation. +
+ +o +ixmlNodetoString
Renders a Node and all sub-elements into an XML text representation. +
+ +o +ixmlRelaxParser
Makes the XML parser more tolerant to malformed text. +
+ +o +ixmlParseBuffer
Parses an XML text buffer converting it into an IXML DOM representation. +
+ +o +ixmlParseBufferEx
Parses an XML text buffer converting it into an IXML DOM representation. +
+ +o +ixmlLoadDocument
Parses an XML text file converting it into an IXML DOM representation. +
+ +o +ixmlLoadDocumentEx
Parses an XML text file converting it into an IXML DOM representation. +
+ +o +ixmlCloneDOMString
Clones an existing DOMString. +
+ +o +ixmlFreeDOMString
Frees a DOMString. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/InterfaceitAttr.html b/docs/dist/html/ixml/InterfaceitAttr.html new file mode 100644 index 0000000..a5db394 --- /dev/null +++ b/docs/dist/html/ixml/InterfaceitAttr.html @@ -0,0 +1,27 @@ + + + + + Interface <I>Attr</I> + + + + +

Interface Attr

+
The Attr interface represents an attribute of an Element. +The document type definition (DTD) or schema usually dictate the +allowable attributes and values for a particular element. For more +information, refer to the Interface Attr section in the DOM2-Core.
+ +
+
+
+ +o +ixmlAttr_free
Frees an Attr node. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/InterfaceitCDATASection.html b/docs/dist/html/ixml/InterfaceitCDATASection.html new file mode 100644 index 0000000..dec96d4 --- /dev/null +++ b/docs/dist/html/ixml/InterfaceitCDATASection.html @@ -0,0 +1,33 @@ + + + + + Interface <I>CDATASection</I> + + + + +

Interface CDATASection

+
The CDATASection is used to escape blocks of text containing +characters that would otherwise be regarded as markup. CDATA sections +cannot be nested. Their primary purpose is for including material such +XML fragments, without needing to escape all the delimiters. For more +information, refer to the Interface CDATASection section in the +DOM2-Core.
+ +
+
+
+ +o +ixmlCDATASection_init
Initializes a CDATASection node. +
+ +o +ixmlCDATASection_free
Frees a CDATASection node. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/InterfaceitDocument.html b/docs/dist/html/ixml/InterfaceitDocument.html new file mode 100644 index 0000000..5ffda03 --- /dev/null +++ b/docs/dist/html/ixml/InterfaceitDocument.html @@ -0,0 +1,103 @@ + + + + + Interface <I>Document</I> + + + + +

Interface Document

+
The Document interface represents the entire XML document. +In essence, it is the root of the document tree and provides the +primary interface to the elements of the document. For more information, +refer to the Interface Document section in the DOM2Core.
+ +
+
+
+ +o +ixmlDocument_init
Initializes a Document node. +
+ +o +ixmlDocument_createDocumentEx
Creates a new empty Document node. +
+ +o +ixmlDocument_createDocument
Creates a new empty Document node. +
+ +o +ixmlDocument_createElementEx
Creates a new Element node with the given tag name. +
+ +o +ixmlDocument_createElement
Creates a new Element node with the given tag name. +
+ +o +ixmlDocument_createTextNodeEx
Creates a new Text node with the given data. +
+ +o +ixmlDocument_createTextNode
Creates a new Text node with the given data. +
+ +o +ixmlDocument_createCDATASectionEx
Creates a new CDATASection node with given data. +
+ +o +ixmlDocument_createCDATASection
Creates a new CDATASection node with given data. +
+ +o +ixmlDocument_createAttribute
Creates a new Attr node with the given name. +
+ +o +ixmlDocument_createAttributeEx
Creates a new Attr node with the given name. +
+ +o +ixmlDocument_getElementsByTagName
Returns a NodeList of all Elements that match the given tag name in the order in which they were encountered in a preorder traversal of the Document tree. +
+ +o +ixmlDocument_createElementNSEx
Creates a new Element node in the given qualified name and namespace URI. +
+ +o +ixmlDocument_createElementNS
Creates a new Element node in the given qualified name and namespace URI. +
+ +o +ixmlDocument_createAttributeNSEx
Creates a new Attr node with the given qualified name and namespace URI. +
+ +o +ixmlDocument_createAttributeNS
Creates a new Attr node with the given qualified name and namespace URI. +
+ +o +ixmlDocument_getElementsByTagNameNS
Returns a NodeList of Elements that match the given local name and namespace URI in the order they are encountered in a preorder traversal of the Document tree. +
+ +o +ixmlDocument_getElementById
Returns the Element whose ID matches that given id. +
+ +o +ixmlDocument_free
Frees a Document object and all Nodes associated with it. +
+ +o +ixmlDocument_importNode
Imports a Node from another Document into this Document. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/InterfaceitElement.html b/docs/dist/html/ixml/InterfaceitElement.html new file mode 100644 index 0000000..f0bc241 --- /dev/null +++ b/docs/dist/html/ixml/InterfaceitElement.html @@ -0,0 +1,96 @@ + + + + + Interface <I>Element</I> + + + + +

Interface Element

+
The Element interface represents an element in an XML document. +Only Elements are allowed to have attributes, which are stored in the +attributes member of a Node. The Element interface +extends the Node interface and adds more operations to manipulate +attributes.
+ +
+
+
+ +o +ixmlElement_init
Initializes a IXML_Element node. +
+ +o +ixmlElement_getTagName
Returns the name of the tag as a constant string. +
+ +o +ixmlElement_getAttribute
Retrieves an attribute of an Element by name. +
+ +o +ixmlElement_setAttribute
Adds a new attribute to an Element. +
+ +o +ixmlElement_removeAttribute
Removes an attribute by name. +
+ +o +ixmlElement_getAttributeNode
Retrieves an attribute node by name. +
+ +o +ixmlElement_setAttributeNode
Adds a new attribute node to an Element. +
+ +o +ixmlElement_removeAttributeNode
Removes the specified attribute node from an Element. +
+ +o +ixmlElement_getElementsByTagName
Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in a pre-order traversal of this Element tree. +
+ +o +ixmlElement_getAttributeNS
Retrieves an attribute value using the local name and namespace URI. +
+ +o +ixmlElement_setAttributeNS
Adds a new attribute to an Element using the local name and namespace URI. +
+ +o +ixmlElement_removeAttributeNS
Removes an attribute using the namespace URI and local name. +
+ +o +ixmlElement_getAttributeNodeNS
Retrieves an Attr node by local name and namespace URI. +
+ +o +ixmlElement_setAttributeNodeNS
Adds a new attribute node. +
+ +o +ixmlElement_getElementsByTagNameNS
Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in the pre-order traversal of the Element tree. +
+ +o +ixmlElement_hasAttribute
Queries whether the Element has an attribute with the given name or a default value. +
+ +o +ixmlElement_hasAttributeNS
Queries whether the Element has an attribute with the given local name and namespace URI or has a default value for that attribute. +
+ +o +ixmlElement_free
Frees the given Element and any subtree of the Element. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/InterfaceitNamedNodeMap.html b/docs/dist/html/ixml/InterfaceitNamedNodeMap.html new file mode 100644 index 0000000..3a27ff5 --- /dev/null +++ b/docs/dist/html/ixml/InterfaceitNamedNodeMap.html @@ -0,0 +1,59 @@ + + + + + Interface <I>NamedNodeMap</I> + + + + +

Interface NamedNodeMap

+
A NamedNodeMap object represents a list of objects that can be +accessed by name. A NamedNodeMap maintains the objects in +no particular order. The Node interface uses a NamedNodeMap +to maintain the attributes of a node.
+ +
+
+
+ +o +ixmlNamedNodeMap_getLength
Returns the number of items contained in this NamedNodeMap. +
+ +o +ixmlNamedNodeMap_getNamedItem
Retrieves a Node from the NamedNodeMap by name. +
+ +o +ixmlNamedNodeMap_setNamedItem
Adds a new Node to the NamedNodeMap using the Node name attribute. +
+ +o +ixmlNamedNodeMap_removeNamedItem
Removes a Node from a NamedNodeMap specified by name. +
+ +o +ixmlNamedNodeMap_item
Retrieves a Node from a NamedNodeMap specified by a numerical index. +
+ +o +ixmlNamedNodeMap_getNamedItemNS
Retrieves a Node from a NamedNodeMap specified by namespace URI and local name. +
+ +o +ixmlNamedNodeMap_setNamedItemNS
Adds a new Node to the NamedNodeMap using the Node local name and namespace URI attributes. +
+ +o +ixmlNamedNodeMap_removeNamedItemNS
Removes a Node from a NamedNodeMap specified by namespace URI and local name. +
+ +o +ixmlNamedNodeMap_free
Frees a NamedNodeMap. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/InterfaceitNode.html b/docs/dist/html/ixml/InterfaceitNode.html new file mode 100644 index 0000000..2bea174 --- /dev/null +++ b/docs/dist/html/ixml/InterfaceitNode.html @@ -0,0 +1,114 @@ + + + + + Interface <I>Node</I> + + + + +

Interface Node

+
The Node interface forms the primary datatype for all other DOM +objects. Every other interface is derived from this interface, inheriting +its functionality. For more information, refer to DOM2-Core page 34.
+ +
+
+
+ +o +ixmlNode_getNodeName
Returns the name of the Node, depending on what type of Node it is, in a read-only string. +
+ +o +ixmlNode_getNodeValue
Returns the value of the Node as a string. +
+ +o +ixmlNode_setNodeValue
Assigns a new value to a Node. +
+ +o +ixmlNode_getNodeType
Retrieves the type of a Node. +
+ +o +ixmlNode_getParentNode
Retrieves the parent Node for a Node. +
+ +o +ixmlNode_getChildNodes
Retrieves the list of children of a Node in a NodeList structure. +
+ +o +ixmlNode_getFirstChild
Retrieves the first child Node of a Node. +
+ +o +ixmlNode_getLastChild
Retrieves the last child Node of a Node. +
+ +o +ixmlNode_getPreviousSibling
Retrieves the sibling Node immediately preceding this Node. +
+ +o +ixmlNode_getNextSibling
Retrieves the sibling Node immediately following this Node. +
+ +o +ixmlNode_getAttributes
Retrieves the attributes of a Node, if it is an Element node, in a NamedNodeMap structure. +
+ +o +ixmlNode_getOwnerDocument
Retrieves the document object associated with this Node. +
+ +o +ixmlNode_getNamespaceURI
Retrieves the namespace URI for a Node as a DOMString. +
+ +o +ixmlNode_getPrefix
Retrieves the namespace prefix, if present. +
+ +o +ixmlNode_getLocalName
Retrieves the local name of a Node, if present. +
+ +o +ixmlNode_insertBefore
Inserts a new child Node before the existing child Node. +
+ +o +ixmlNode_replaceChild
Replaces an existing child Node with a new child Node in the list of children of a Node. +
+ +o +ixmlNode_removeChild
Removes a child from the list of children of a Node. +
+ +o +ixmlNode_appendChild
Appends a child Node to the list of children of a Node. +
+ +o +ixmlNode_hasChildNodes
Queries whether or not a Node has children. +
+ +o +ixmlNode_cloneNode
Clones a Node. +
+ +o +ixmlNode_hasAttributes
Queries whether this Node has attributes. +
+ +o +ixmlNode_free
Frees a Node and all Nodes in its subtree. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/InterfaceitNodeList.html b/docs/dist/html/ixml/InterfaceitNodeList.html new file mode 100644 index 0000000..54ecabe --- /dev/null +++ b/docs/dist/html/ixml/InterfaceitNodeList.html @@ -0,0 +1,35 @@ + + + + + Interface <I>NodeList</I> + + + + +

Interface NodeList

+
The NodeList interface abstracts an ordered collection of +nodes. Note that changes to the underlying nodes will change +the nodes contained in a NodeList. The DOM2-Core refers to +this as being live.
+ +
+
+
+ +o +ixmlNodeList_item
Retrieves a Node from a NodeList specified by a numerical index. +
+ +o +ixmlNodeList_length
Returns the number of Nodes in a NodeList. +
+ +o +ixmlNodeList_free
Frees a NodeList object. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/Introduction.html b/docs/dist/html/ixml/Introduction.html new file mode 100644 index 0000000..ad5fea3 --- /dev/null +++ b/docs/dist/html/ixml/Introduction.html @@ -0,0 +1,40 @@ + + + + + Introduction + + + + +

Introduction

+
The Linux DOM2 XML Parser Version 1.2 (IXML) is a lightweight, portable XML +parser supporting the standard Document Object Model (DOM) Level 2 +interfaces. The parser uses a C-style interface, making it idea for small, +embedded applications. This document describes the interfaces supported by +IXML 1.2, referencing the W3C DOM2 recommendations when necessary, and the +additional utility application programming interfaces (APIs) that it +supports. + +

Note that this document assumes that the reader has a copy of the DOM2-Core +recommendation. Refer to the link below to obtain a copy. Only a brief +description is included here and the reader is pointed to the DOM2-Core +recommendation for more details. This document does, however, clarify +IXML-specific behavior when the recommendation is unclear. + +

About DOM + +

The Document Object Model (DOM) is a set of interfaces that give a +programmatic interface to documents. It provides a platform-neutral and +language-neutral interface for random access and updating elements inside +XML documents. DOM Level 1 provided the basic interfaces to access +document elements. DOM Level 2 extended the interfaces to provide proper +support for XML namespaces. + +

The latest DOM 2 recommendation is maintained by W3C and is available from +http://www.w3.org/TR/DOM-Level-2-Core.

+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/License.html b/docs/dist/html/ixml/License.html new file mode 100644 index 0000000..d1668c7 --- /dev/null +++ b/docs/dist/html/ixml/License.html @@ -0,0 +1,45 @@ + + + + + License + + + + +

License

+
+
+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. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/icon1.gif b/docs/dist/html/ixml/icon1.gif new file mode 100644 index 0000000..f78f30e Binary files /dev/null and b/docs/dist/html/ixml/icon1.gif differ diff --git a/docs/dist/html/ixml/icon2.gif b/docs/dist/html/ixml/icon2.gif new file mode 100644 index 0000000..6cbe01a Binary files /dev/null and b/docs/dist/html/ixml/icon2.gif differ diff --git a/docs/dist/html/ixml/index.html b/docs/dist/html/ixml/index.html new file mode 100644 index 0000000..eb4bb7b --- /dev/null +++ b/docs/dist/html/ixml/index.html @@ -0,0 +1,41 @@ + + + + + IXML v1.2 + + + + +

IXML v1.2

+
+Linux DOM2 XML Parser Version 1.2 + +

Copyright (C) 2000-2003 Intel Corporation ALL RIGHTS RESERVED + +

Revision 1.2.1 (Tue 04 Jul 2006 04:58:36 PM EEST) +

+ +
+
+
+ +o +Introduction
+ +o +License
+ +o +BOOL
+ +o +DOM Interfaces
+ +o +IXML API
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlAttr_free.html b/docs/dist/html/ixml/ixmlAttr_free.html new file mode 100644 index 0000000..30488e3 --- /dev/null +++ b/docs/dist/html/ixml/ixmlAttr_free.html @@ -0,0 +1,23 @@ + + + + + EXPORT_SPEC void ixmlAttr_free + + + + +

EXPORT_SPEC void ixmlAttr_free

(IXML_Attr* attrNode )

Frees an Attr node.
+ + +
+

Documentation

+
Frees an Attr node. + +

+
Parameters:
attrNode - The Attr node to free.
Returns:
[void] This function does not return a value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlCDATASection_free.html b/docs/dist/html/ixml/ixmlCDATASection_free.html new file mode 100644 index 0000000..5137a83 --- /dev/null +++ b/docs/dist/html/ixml/ixmlCDATASection_free.html @@ -0,0 +1,23 @@ + + + + + EXPORT_SPEC void ixmlCDATASection_free + + + + +

EXPORT_SPEC void ixmlCDATASection_free

(IXML_CDATASection* nodeptr )

Frees a CDATASection node.
+ + +
+

Documentation

+
Frees a CDATASection node. + +

+
Parameters:
nodeptr - The CDATASection node to free.
Returns:
[void] This function does not return a value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlCDATASection_init.html b/docs/dist/html/ixml/ixmlCDATASection_init.html new file mode 100644 index 0000000..3d31b60 --- /dev/null +++ b/docs/dist/html/ixml/ixmlCDATASection_init.html @@ -0,0 +1,23 @@ + + + + + EXPORT_SPEC void ixmlCDATASection_init + + + + +

EXPORT_SPEC void ixmlCDATASection_init

(IXML_CDATASection* nodeptr )

Initializes a CDATASection node.
+ + +
+

Documentation

+
Initializes a CDATASection node. + +

+
Parameters:
nodeptr - The CDATASection node to initialize.
Returns:
[void] This function does not return a value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlCloneDOMString.html b/docs/dist/html/ixml/ixmlCloneDOMString.html new file mode 100644 index 0000000..5cc252a --- /dev/null +++ b/docs/dist/html/ixml/ixmlCloneDOMString.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC DOMString ixmlCloneDOMString + + + + +

EXPORT_SPEC DOMString ixmlCloneDOMString

(const DOMString src )

Clones an existing DOMString.
+ + +
+

Documentation

+
Clones an existing DOMString. + +

+
Parameters:
src - The source DOMString to clone.
Returns:
[DOMString] A new DOMString that is a duplicate of the +original or NULL if the operation could not +be completed. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createAttribute.html b/docs/dist/html/ixml/ixmlDocument_createAttribute.html new file mode 100644 index 0000000..fab01cc --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createAttribute.html @@ -0,0 +1,24 @@ + + + + + EXPORT_SPEC IXML_Attr* ixmlDocument_createAttribute + + + + +

EXPORT_SPEC IXML_Attr* ixmlDocument_createAttribute

(IXML_Document* doc,
  char* name )

Creates a new Attr node with the given name.
+ + +
+

Documentation

+
Creates a new Attr node with the given name. + +

+
Parameters:
doc - The owner Document of the new node. +
name - The name of the new attribute.
Returns:
[Attr*] A pointer to the new Attr or NULL on failure. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createAttributeEx.html b/docs/dist/html/ixml/ixmlDocument_createAttributeEx.html new file mode 100644 index 0000000..c9a7831 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createAttributeEx.html @@ -0,0 +1,38 @@ + + + + + EXPORT_SPEC int ixmlDocument_createAttributeEx + + + + +

EXPORT_SPEC int ixmlDocument_createAttributeEx

(IXML_Document* doc,
  char* name,
  IXML_Attr** attrNode )

Creates a new Attr node with the given name.
+ + +
+

Documentation

+
Creates a new Attr node with the given name. + +

The ixmlDocument_createAttributeEx API differs from the +ixmlDocument_createAttribute API in that it returns an error code +describing the reason for failure rather than just NULL. + +

+
Parameters:
doc - The owner Document of the new +node. +
name - The name of the new attribute. +
attrNode - A pointer to a Attr where the new +object will be stored.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either doc or name +is NULL. +
  • IXML_INSUFFICIENT_MEMORY: Not enough free memory exists +to complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createAttributeNS.html b/docs/dist/html/ixml/ixmlDocument_createAttributeNS.html new file mode 100644 index 0000000..1592e62 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createAttributeNS.html @@ -0,0 +1,27 @@ + + + + + EXPORT_SPEC IXML_Attr* ixmlDocument_createAttributeNS + + + + +

EXPORT_SPEC IXML_Attr* ixmlDocument_createAttributeNS

(IXML_Document* doc,
  DOMString namespaceURI,
  DOMString qualifiedName )

Creates a new Attr node with the given qualified name and namespace URI.
+ + +
+

Documentation

+
Creates a new Attr node with the given qualified name and +namespace URI. + +

+
Parameters:
doc - The owner Document of the new +Attr. +
namespaceURI - The namespace URI for the attribute. +
qualifiedName - The qualified name of the attribute.
Returns:
[Attr*] A pointer to the new Attr or NULL on failure. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createAttributeNSEx.html b/docs/dist/html/ixml/ixmlDocument_createAttributeNSEx.html new file mode 100644 index 0000000..3d8352f --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createAttributeNSEx.html @@ -0,0 +1,40 @@ + + + + + EXPORT_SPEC int ixmlDocument_createAttributeNSEx + + + + +

EXPORT_SPEC int ixmlDocument_createAttributeNSEx

(IXML_Document* doc,
  DOMString namespaceURI,
  DOMString qualifiedName,
  IXML_Attr** attrNode )

Creates a new Attr node with the given qualified name and namespace URI.
+ + +
+

Documentation

+
Creates a new Attr node with the given qualified name and +namespace URI. + +

The ixmlDocument_createAttributeNSEx API differs from the +ixmlDocument_createAttributeNS API in that it returns an error code +describing the reason for failure rather than just NULL. + +

+
Parameters:
doc - The owner Document of the new +Attr. +
namespaceURI - The namespace URI for the attribute. +
qualifiedName - The qualified name of the attribute. +
attrNode - A pointer to an Attr where the +new object will be stored.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either doc, +namespaceURI, or qualifiedName is NULL. +
  • IXML_INSUFFICIENT_MEMORY: Not enough free memory exists +to complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createCDATASection.html b/docs/dist/html/ixml/ixmlDocument_createCDATASection.html new file mode 100644 index 0000000..d9bd1c1 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createCDATASection.html @@ -0,0 +1,27 @@ + + + + + EXPORT_SPEC IXML_CDATASection* ixmlDocument_createCDATASection + + + + +

EXPORT_SPEC IXML_CDATASection* ixmlDocument_createCDATASection

(IXML_Document* doc,
  DOMString data )

Creates a new CDATASection node with given data.
+ + +
+

Documentation

+
Creates a new CDATASection node with given data. + +

+
Parameters:
doc - The owner Document of the new +node. +
data - The data to associate with the new +CDATASection node.
Returns:
[CDATASection*] A pointer to the new CDATASection or +NULL on failure. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createCDATASectionEx.html b/docs/dist/html/ixml/ixmlDocument_createCDATASectionEx.html new file mode 100644 index 0000000..24f5210 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createCDATASectionEx.html @@ -0,0 +1,39 @@ + + + + + EXPORT_SPEC int ixmlDocument_createCDATASectionEx + + + + +

EXPORT_SPEC int ixmlDocument_createCDATASectionEx

(IXML_Document* doc,
  DOMString data,
  IXML_CDATASection** cdNode )

Creates a new CDATASection node with given data.
+ + +
+

Documentation

+
Creates a new CDATASection node with given data. + +

The ixmlDocument_createCDATASectionEx API differs from the +ixmlDocument_createCDATASection API in that it returns an error code +describing the reason for failure rather than just NULL. + +

+
Parameters:
doc - The owner Document of the new +node. +
data - The data to associate with the new +CDATASection node. +
cdNode - A pointer to a Node where the +new object will be stored.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either doc or {\bd data} +is NULL. +
  • IXML_INSUFFICIENT_MEMORY: Not enough free memory exists +to complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createDocument.html b/docs/dist/html/ixml/ixmlDocument_createDocument.html new file mode 100644 index 0000000..78cffa6 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createDocument.html @@ -0,0 +1,23 @@ + + + + + EXPORT_SPEC IXML_Document* ixmlDocument_createDocument + + + + +

EXPORT_SPEC IXML_Document* ixmlDocument_createDocument

()

Creates a new empty Document node.
+ + +
+

Documentation

+
Creates a new empty Document node. + +

+
Returns:
[Document*] A pointer to the new Document or NULL on +failure.

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createDocumentEx.html b/docs/dist/html/ixml/ixmlDocument_createDocumentEx.html new file mode 100644 index 0000000..d17421f --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createDocumentEx.html @@ -0,0 +1,32 @@ + + + + + EXPORT_SPEC int ixmlDocument_createDocumentEx + + + + +

EXPORT_SPEC int ixmlDocument_createDocumentEx

(IXML_Document** doc )

Creates a new empty Document node.
+ + +
+

Documentation

+
Creates a new empty Document node. The +ixmlDocument_createDocumentEx API differs from the +ixmlDocument_createDocument API in that it returns an error code +describing the reason for the failure rather than just NULL. + +

+
Parameters:
doc - Pointer to a Document where the +new object will be stored.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INSUFFICIENT_MEMORY: Not enough free memory exists +to complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createElement.html b/docs/dist/html/ixml/ixmlDocument_createElement.html new file mode 100644 index 0000000..2203a60 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createElement.html @@ -0,0 +1,29 @@ + + + + + EXPORT_SPEC IXML_Element* ixmlDocument_createElement + + + + +

EXPORT_SPEC IXML_Element* ixmlDocument_createElement

(IXML_Document* doc,
  const DOMString tagName )

Creates a new Element node with the given tag name.
+ + +
+

Documentation

+
Creates a new Element node with the given tag name. The new +Element node has a nodeName of tagName and +the localName, prefix, and namespaceURI set +to NULL. To create an Element with a namespace, +see ixmlDocument_createElementNS. + +

+
Parameters:
doc - The owner Document of the new node. +
tagName - The tag name of the new Element node.
Returns:
[Document*] A pointer to the new Element or NULL on +failure. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createElementEx.html b/docs/dist/html/ixml/ixmlDocument_createElementEx.html new file mode 100644 index 0000000..d10fda0 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createElementEx.html @@ -0,0 +1,42 @@ + + + + + EXPORT_SPEC int ixmlDocument_createElementEx + + + + +

EXPORT_SPEC int ixmlDocument_createElementEx

(IXML_Document* doc,
  const DOMString tagName,
  IXML_Element** rtElement )

Creates a new Element node with the given tag name.
+ + +
+

Documentation

+
Creates a new Element node with the given tag name. The new +Element node has a nodeName of tagName and +the localName, prefix, and namespaceURI set +to NULL. To create an Element with a namespace, +see ixmlDocument_createElementNS. + +

The ixmlDocument_createElementEx API differs from the +ixmlDocument_createElement API in that it returns an error code +describing the reason for failure rather than just NULL. + +

+
Parameters:
doc - The owner Document of the new node. +
tagName - The tag name of the new Element +node. +
rtElement - Pointer to an Element where the new +object will be stored.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either doc or +tagName is NULL. +
  • IXML_INSUFFICIENT_MEMORY: Not enough free memory exists +to complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createElementNS.html b/docs/dist/html/ixml/ixmlDocument_createElementNS.html new file mode 100644 index 0000000..2118ae8 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createElementNS.html @@ -0,0 +1,29 @@ + + + + + EXPORT_SPEC IXML_Element* ixmlDocument_createElementNS + + + + +

EXPORT_SPEC IXML_Element* ixmlDocument_createElementNS

(IXML_Document* doc,
  DOMString namespaceURI,
  DOMString qualifiedName )

Creates a new Element node in the given qualified name and namespace URI.
+ + +
+

Documentation

+
Creates a new Element node in the given qualified name and +namespace URI. + +

+
Parameters:
doc - The owner Document of the new node. +
namespaceURI - The namespace URI for the new +Element. +
qualifiedName - The qualified name of the new +Element.
Returns:
[Element*] A pointer to the new Element or NULL on +failure. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createElementNSEx.html b/docs/dist/html/ixml/ixmlDocument_createElementNSEx.html new file mode 100644 index 0000000..86dbafb --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createElementNSEx.html @@ -0,0 +1,42 @@ + + + + + EXPORT_SPEC int ixmlDocument_createElementNSEx + + + + +

EXPORT_SPEC int ixmlDocument_createElementNSEx

(IXML_Document* doc,
  DOMString namespaceURI,
  DOMString qualifiedName,
  IXML_Element** rtElement )

Creates a new Element node in the given qualified name and namespace URI.
+ + +
+

Documentation

+
Creates a new Element node in the given qualified name and +namespace URI. + +

The ixmlDocument_createElementNSEx API differs from the +ixmlDocument_createElementNS API in that it returns an error code +describing the reason for failure rather than just NULL. + +

+
Parameters:
doc - The owner Document of the new +node. +
namespaceURI - The namespace URI for the new +Element. +
qualifiedName - The qualified name of the new +Element. +
rtElement - A pointer to an Element where the +new object will be stored.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either doc, +namespaceURI, or qualifiedName is NULL. +
  • IXML_INSUFFICIENT_MEMORY: Not enough free memory exists +to complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createTextNode.html b/docs/dist/html/ixml/ixmlDocument_createTextNode.html new file mode 100644 index 0000000..e9f7e5e --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createTextNode.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlDocument_createTextNode + + + + +

EXPORT_SPEC IXML_Node* ixmlDocument_createTextNode

(IXML_Document* doc,
  const DOMString data )

Creates a new Text node with the given data.
+ + +
+

Documentation

+
Creates a new Text node with the given data. + +

+
Parameters:
doc - The owner Document of the new node. +
data - The data to associate with the new Text +node.
Returns:
[Node*] A pointer to the new Node or NULL on failure. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_createTextNodeEx.html b/docs/dist/html/ixml/ixmlDocument_createTextNodeEx.html new file mode 100644 index 0000000..e18f413 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_createTextNodeEx.html @@ -0,0 +1,37 @@ + + + + + EXPORT_SPEC int ixmlDocument_createTextNodeEx + + + + +

EXPORT_SPEC int ixmlDocument_createTextNodeEx

(IXML_Document* doc,
  const DOMString data,
  IXML_Node** textNode )

Creates a new Text node with the given data.
+ + +
+

Documentation

+
Creates a new Text node with the given data. +The ixmlDocument_createTextNodeEx API differs from the +ixmlDocument_createTextNode API in that it returns an error code +describing the reason for failure rather than just NULL. + +

+
Parameters:
doc - The owner Document of the new node. +
data - The data to associate with the new +Text node. +
textNode - A pointer to a Node where the new +object will be stored.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either doc or data +is NULL. +
  • IXML_INSUFFICIENT_MEMORY: Not enough free memory exists +to complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_free.html b/docs/dist/html/ixml/ixmlDocument_free.html new file mode 100644 index 0000000..3034b19 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_free.html @@ -0,0 +1,26 @@ + + + + + EXPORT_SPEC void ixmlDocument_free + + + + +

EXPORT_SPEC void ixmlDocument_free

(IXML_Document* doc )

Frees a Document object and all Nodes associated with it.
+ + +
+

Documentation

+
Frees a Document object and all Nodes associated with it. +Any Nodes extracted via any other interface function, e.g. +ixmlDocument_GetElementById, become invalid after this call unless +explicitly cloned. + +

+
Parameters:
doc - The Document to free.
Returns:
[void] This function does not return a value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_getElementById.html b/docs/dist/html/ixml/ixmlDocument_getElementById.html new file mode 100644 index 0000000..9e0ac60 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_getElementById.html @@ -0,0 +1,26 @@ + + + + + EXPORT_SPEC IXML_Element* ixmlDocument_getElementById + + + + +

EXPORT_SPEC IXML_Element* ixmlDocument_getElementById

(IXML_Document* doc,
  DOMString tagName )

Returns the Element whose ID matches that given id.
+ + +
+

Documentation

+
Returns the Element whose ID matches that given id. + +

+
Parameters:
doc - The owner Document of the +Element. +
tagName - The name of the Element.
Returns:
[Element*] A pointer to the matching Element or +NULL on an error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_getElementsByTagName.html b/docs/dist/html/ixml/ixmlDocument_getElementsByTagName.html new file mode 100644 index 0000000..b9f1906 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_getElementsByTagName.html @@ -0,0 +1,27 @@ + + + + + EXPORT_SPEC IXML_NodeList* ixmlDocument_getElementsByTagName + + + + +

EXPORT_SPEC IXML_NodeList* ixmlDocument_getElementsByTagName

(IXML_Document* doc,
  DOMString tagName )

Returns a NodeList of all Elements that match the given tag name in the order in which they were encountered in a preorder traversal of the Document tree.
+ + +
+

Documentation

+
Returns a NodeList of all Elements that match the given +tag name in the order in which they were encountered in a preorder +traversal of the Document tree. + +

+
Parameters:
doc - The Document to search. +
tagName - The tag name to find.
Returns:
[NodeList*] A pointer to a NodeList containing the +matching items or NULL on an error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_getElementsByTagNameNS.html b/docs/dist/html/ixml/ixmlDocument_getElementsByTagNameNS.html new file mode 100644 index 0000000..3fcc775 --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_getElementsByTagNameNS.html @@ -0,0 +1,34 @@ + + + + + EXPORT_SPEC IXML_NodeList* ixmlDocument_getElementsByTagNameNS + + + + +

EXPORT_SPEC IXML_NodeList* ixmlDocument_getElementsByTagNameNS

(IXML_Document* doc,
  DOMString namespaceURI,
  DOMString localName )

Returns a NodeList of Elements that match the given local name and namespace URI in the order they are encountered in a preorder traversal of the Document tree.
+ + +
+

Documentation

+
Returns a NodeList of Elements that match the given +local name and namespace URI in the order they are encountered +in a preorder traversal of the Document tree. Either +namespaceURI or localName can be the special "*" +character, which matches any namespace or any local name respectively. + +

+
Parameters:
doc - The Document to search. +
namespaceURI - The namespace of the elements to +find or "*" to match any +namespace. +
localName - The local name of the elements to +find or "*" to match any local +name.
Returns:
[NodeList*] A pointer to a NodeList containing the +matching items or NULL on an error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_importNode.html b/docs/dist/html/ixml/ixmlDocument_importNode.html new file mode 100644 index 0000000..3415a4c --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_importNode.html @@ -0,0 +1,43 @@ + + + + + EXPORT_SPEC int ixmlDocument_importNode + + + + +

EXPORT_SPEC int ixmlDocument_importNode

(IXML_Document* doc,
  IXML_Node* importNode,
  BOOL deep,
  IXML_Node** rtNode )

Imports a Node from another Document into this Document.
+ + +
+

Documentation

+
Imports a Node from another Document into this +Document. The new Node does not a have parent node: it is a +clone of the original Node with the ownerDocument set to +doc. The deep parameter controls whether all the children +of the Node are imported. Refer to the DOM2-Core recommendation +for details on importing specific node types. + +

+
Parameters:
doc - The Document into which to import. +
importNode - The Node to import. +
deep - TRUE to import all children of +importNode or FALSE to import only the +root node. +
rtNode - A pointer to a new Node owned by +doc.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either doc or +importNode is not a valid pointer. +
  • IXML_NOT_SUPPORTED_ERR: importNode is a +Document, which cannot be imported. +
  • IXML_FAILED: The import operation failed because the +Node to be imported could not be cloned. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocument_init.html b/docs/dist/html/ixml/ixmlDocument_init.html new file mode 100644 index 0000000..f2db8ee --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocument_init.html @@ -0,0 +1,23 @@ + + + + + EXPORT_SPEC void ixmlDocument_init + + + + +

EXPORT_SPEC void ixmlDocument_init

(IXML_Document* nodeptr )

Initializes a Document node.
+ + +
+

Documentation

+
Initializes a Document node. + +

+
Parameters:
nodeptr - The Document node to initialize.
Returns:
[void] This function does not return a value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlDocumenttoString.html b/docs/dist/html/ixml/ixmlDocumenttoString.html new file mode 100644 index 0000000..d7c82ae --- /dev/null +++ b/docs/dist/html/ixml/ixmlDocumenttoString.html @@ -0,0 +1,33 @@ + + + + + DOMString ixmlDocumenttoString + + + + +

DOMString ixmlDocumenttoString

(IXML_Document* doc)

Renders a Node and all sub-elements into an XML document representation.
+ + +
+

Documentation

+
Renders a Node and all sub-elements into an XML document +representation. The caller is required to free the DOMString +returned from this function using ixmlFreeDOMString when it +is no longer required. + +

Note that this function can be used for any Node-derived +interface. The difference between ixmlDocumenttoString and +ixmlNodetoString is ixmlDocumenttoString includes the XML +prolog while ixmlNodetoString only produces XML elements. An XML +document is not well formed unless it includes the prolog +and at least one element. + +

+
Returns:
[DOMString] A DOMString with the XML text representation +of the DOM tree or NULL on an error.

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_free.html b/docs/dist/html/ixml/ixmlElement_free.html new file mode 100644 index 0000000..c96604c --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_free.html @@ -0,0 +1,23 @@ + + + + + EXPORT_SPEC void ixmlElement_free + + + + +

EXPORT_SPEC void ixmlElement_free

(IXML_Element* element )

Frees the given Element and any subtree of the Element.
+ + +
+

Documentation

+
Frees the given Element and any subtree of the Element. + +

+
Parameters:
element - The Element to free.
Returns:
[void] This function does not return a value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_getAttribute.html b/docs/dist/html/ixml/ixmlElement_getAttribute.html new file mode 100644 index 0000000..6df3db4 --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_getAttribute.html @@ -0,0 +1,26 @@ + + + + + EXPORT_SPEC DOMString ixmlElement_getAttribute + + + + +

EXPORT_SPEC DOMString ixmlElement_getAttribute

(IXML_Element* element,
  DOMString name )

Retrieves an attribute of an Element by name.
+ + +
+

Documentation

+
Retrieves an attribute of an Element by name. + +

+
Parameters:
element - The Element from which to retrieve the +attribute. +
name - The name of the attribute to retrieve.
Returns:
[DOMString] A DOMString representing the value of the +attribute. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_getAttributeNS.html b/docs/dist/html/ixml/ixmlElement_getAttributeNS.html new file mode 100644 index 0000000..22475a6 --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_getAttributeNS.html @@ -0,0 +1,27 @@ + + + + + EXPORT_SPEC DOMString ixmlElement_getAttributeNS + + + + +

EXPORT_SPEC DOMString ixmlElement_getAttributeNS

(IXML_Element* element,
  DOMString namespaceURI,
  DOMString localname )

Retrieves an attribute value using the local name and namespace URI.
+ + +
+

Documentation

+
Retrieves an attribute value using the local name and namespace URI. + +

+
Parameters:
element - The Element from which to get the +attribute value. +
namespaceURI - The namespace URI of the attribute. +
localname - The local name of the attribute.
Returns:
[DOMString] A DOMString representing the value of the +matching attribute. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_getAttributeNode.html b/docs/dist/html/ixml/ixmlElement_getAttributeNode.html new file mode 100644 index 0000000..e70bfa2 --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_getAttributeNode.html @@ -0,0 +1,28 @@ + + + + + EXPORT_SPEC IXML_Attr* ixmlElement_getAttributeNode + + + + +

EXPORT_SPEC IXML_Attr* ixmlElement_getAttributeNode

(IXML_Element* element,
  DOMString name )

Retrieves an attribute node by name.
+ + +
+

Documentation

+
Retrieves an attribute node by name. See +ixmlElement_getAttributeNodeNS to retrieve an attribute node using +a qualified name or namespace URI. + +

+
Parameters:
element - The Element from which to get the +attribute node. +
name - The name of the attribute node to find.
Returns:
[Attr*] A pointer to the attribute matching name or +NULL on an error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_getAttributeNodeNS.html b/docs/dist/html/ixml/ixmlElement_getAttributeNodeNS.html new file mode 100644 index 0000000..f4af556 --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_getAttributeNodeNS.html @@ -0,0 +1,26 @@ + + + + + EXPORT_SPEC IXML_Attr* ixmlElement_getAttributeNodeNS + + + + +

EXPORT_SPEC IXML_Attr* ixmlElement_getAttributeNodeNS

(IXML_Element* element,
  DOMString namespaceURI,
  DOMString localName )

Retrieves an Attr node by local name and namespace URI.
+ + +
+

Documentation

+
Retrieves an Attr node by local name and namespace URI. + +

+
Parameters:
element - The Element from which to get the +attribute. +
namespaceURI - The namespace URI of the attribute. +
localName - The local name of the attribute.
Returns:
[Attr*] A pointer to an Attr or NULL on an error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_getElementsByTagName.html b/docs/dist/html/ixml/ixmlElement_getElementsByTagName.html new file mode 100644 index 0000000..bfe498d --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_getElementsByTagName.html @@ -0,0 +1,29 @@ + + + + + EXPORT_SPEC IXML_NodeList* ixmlElement_getElementsByTagName + + + + +

EXPORT_SPEC IXML_NodeList* ixmlElement_getElementsByTagName

(IXML_Element* element,
  DOMString tagName )

Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in a pre-order traversal of this Element tree.
+ + +
+

Documentation

+
Returns a NodeList of all descendant Elements with +a given tag name, in the order in which they are encountered in a +pre-order traversal of this Element tree. + +

+
Parameters:
element - The Element from which to start +the search. +
tagName - The name of the tag for which to +search.
Returns:
[NodeList*] A NodeList of the matching Elements or +NULL on an error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_getElementsByTagNameNS.html b/docs/dist/html/ixml/ixmlElement_getElementsByTagNameNS.html new file mode 100644 index 0000000..d0cf38b --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_getElementsByTagNameNS.html @@ -0,0 +1,31 @@ + + + + + EXPORT_SPEC IXML_NodeList* ixmlElement_getElementsByTagNameNS + + + + +

EXPORT_SPEC IXML_NodeList* ixmlElement_getElementsByTagNameNS

(IXML_Element* element,
  DOMString namespaceURI,
  DOMString localName )

Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in the pre-order traversal of the Element tree.
+ + +
+

Documentation

+
Returns a NodeList of all descendant Elements with a +given tag name, in the order in which they are encountered in the +pre-order traversal of the Element tree. + +

+
Parameters:
element - The Element from which to start +the search. +
namespaceURI - The namespace URI of the +Elements to find. +
localName - The local name of the Elements +to find.
Returns:
[NodeList*] A NodeList of matching Elements or +NULL on an error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_getTagName.html b/docs/dist/html/ixml/ixmlElement_getTagName.html new file mode 100644 index 0000000..3c20b73 --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_getTagName.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC const DOMString ixmlElement_getTagName + + + + +

EXPORT_SPEC const DOMString ixmlElement_getTagName

(IXML_Element* element )

Returns the name of the tag as a constant string.
+ + +
+

Documentation

+
Returns the name of the tag as a constant string. + +

+
Parameters:
element - The Element from which to retrieve the +name.
Returns:
[const DOMString] A DOMString representing the name of the +Element. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_hasAttribute.html b/docs/dist/html/ixml/ixmlElement_hasAttribute.html new file mode 100644 index 0000000..d00ca29 --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_hasAttribute.html @@ -0,0 +1,28 @@ + + + + + EXPORT_SPEC BOOL ixmlElement_hasAttribute + + + + +

EXPORT_SPEC BOOL ixmlElement_hasAttribute

(IXML_Element* element,
  DOMString name )

Queries whether the Element has an attribute with the given name or a default value.
+ + +
+

Documentation

+
Queries whether the Element has an attribute with the given name +or a default value. + +

+
Parameters:
element - The Element on which to check for an +attribute. +
name - The name of the attribute for which to check.
Returns:
[BOOL] TRUE if the Element has an attribute with +this name or has a default value for that attribute, +otherwise FALSE. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_hasAttributeNS.html b/docs/dist/html/ixml/ixmlElement_hasAttributeNS.html new file mode 100644 index 0000000..0616675 --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_hasAttributeNS.html @@ -0,0 +1,29 @@ + + + + + EXPORT_SPEC BOOL ixmlElement_hasAttributeNS + + + + +

EXPORT_SPEC BOOL ixmlElement_hasAttributeNS

(IXML_Element* element,
  DOMString namespaceURI,
  DOMString localName )

Queries whether the Element has an attribute with the given local name and namespace URI or has a default value for that attribute.
+ + +
+

Documentation

+
Queries whether the Element has an attribute with the given +local name and namespace URI or has a default value for that attribute. + +

+
Parameters:
element - The Element on which to check for the +attribute. +
namespaceURI - The namespace URI of the attribute. +
localName - The local name of the attribute.
Returns:
[BOOL] TRUE if the Element has an attribute with +the given namespace and local name or has a default +value for that attribute, otherwise FALSE. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_init.html b/docs/dist/html/ixml/ixmlElement_init.html new file mode 100644 index 0000000..5c0fcff --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_init.html @@ -0,0 +1,23 @@ + + + + + EXPORT_SPEC void ixmlElement_init + + + + +

EXPORT_SPEC void ixmlElement_init

(IXML_Element* element )

Initializes a IXML_Element node.
+ + +
+

Documentation

+
Initializes a IXML_Element node. + +

+
Parameters:
element - The Element to initialize.
Returns:
[void] This function does not return a value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_removeAttribute.html b/docs/dist/html/ixml/ixmlElement_removeAttribute.html new file mode 100644 index 0000000..cc469ed --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_removeAttribute.html @@ -0,0 +1,30 @@ + + + + + EXPORT_SPEC int ixmlElement_removeAttribute + + + + +

EXPORT_SPEC int ixmlElement_removeAttribute

(IXML_Element* element,
  DOMString name )

Removes an attribute by name.
+ + +
+

Documentation

+
Removes an attribute by name. + +

+
Parameters:
element - The Element from which to remove the +attribute. +
name - The name of the attribute to remove.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either element or +name is NULL. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_removeAttributeNS.html b/docs/dist/html/ixml/ixmlElement_removeAttributeNS.html new file mode 100644 index 0000000..5601ba3 --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_removeAttributeNS.html @@ -0,0 +1,31 @@ + + + + + EXPORT_SPEC int ixmlElement_removeAttributeNS + + + + +

EXPORT_SPEC int ixmlElement_removeAttributeNS

(IXML_Element* element,
  DOMString namespaceURI,
  DOMString localName )

Removes an attribute using the namespace URI and local name.
+ + +
+

Documentation

+
Removes an attribute using the namespace URI and local name. + +

+
Parameters:
element - The Element from which to remove the +the attribute. +
namespaceURI - The namespace URI of the attribute. +
localName - The local name of the attribute.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either element, +namespaceURI, or localName is NULL. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_removeAttributeNode.html b/docs/dist/html/ixml/ixmlElement_removeAttributeNode.html new file mode 100644 index 0000000..7dc62a3 --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_removeAttributeNode.html @@ -0,0 +1,35 @@ + + + + + EXPORT_SPEC int ixmlElement_removeAttributeNode + + + + +

EXPORT_SPEC int ixmlElement_removeAttributeNode

(IXML_Element* element,
  IXML_Attr* oldAttr,
  IXML_Attr** rtAttr )

Removes the specified attribute node from an Element.
+ + +
+

Documentation

+
Removes the specified attribute node from an Element. + +

+
Parameters:
element - The Element from which to remove +the attribute. +
oldAttr - The attribute to remove from the +Element. +
rtAttr - A pointer to an attribute in which to +place the removed attribute.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either element or +oldAttr is NULL. +
  • IXML_NOT_FOUND_ERR: oldAttr is not among the list +attributes of element. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_setAttribute.html b/docs/dist/html/ixml/ixmlElement_setAttribute.html new file mode 100644 index 0000000..ca6838e --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_setAttribute.html @@ -0,0 +1,39 @@ + + + + + EXPORT_SPEC int ixmlElement_setAttribute + + + + +

EXPORT_SPEC int ixmlElement_setAttribute

(IXML_Element* element,
  DOMString name,
  DOMString value )

Adds a new attribute to an Element.
+ + +
+

Documentation

+
Adds a new attribute to an Element. If an attribute with the same +name already exists, the attribute value will be updated with the +new value in value. + +

+
Parameters:
element - The Element on which to set the +attribute. +
name - The name of the attribute. +
value - The value of the attribute. Note that this is +a non-parsed string and any markup must be +escaped.
Returns:
[int] An integer representing of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either element, +name, or value is NULL. +
  • IXML_INVALID_CHARACTER_ERR: name contains an +illegal character. +
  • IXML_INSUFFICIENT_MEMORY: Not enough free memory exists +to complete the operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_setAttributeNS.html b/docs/dist/html/ixml/ixmlElement_setAttributeNS.html new file mode 100644 index 0000000..45b3b96 --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_setAttributeNS.html @@ -0,0 +1,44 @@ + + + + + EXPORT_SPEC int ixmlElement_setAttributeNS + + + + +

EXPORT_SPEC int ixmlElement_setAttributeNS

(IXML_Element* element,
  DOMString namespaceURI,
  DOMString qualifiedName,
  DOMString value )

Adds a new attribute to an Element using the local name and namespace URI.
+ + +
+

Documentation

+
Adds a new attribute to an Element using the local name and +namespace URI. If another attribute matches the same local name and +namespace, the prefix is changed to be the prefix part of the +qualifiedName and the value is changed to value. + +

+
Parameters:
element - The Element on which to set the +attribute. +
namespaceURI - The namespace URI of the new attribute. +
qualifiedName - The qualified name of the attribute. +
value - The new value for the attribute.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either element, +namespaceURI, qualifiedName, or value is +NULL. +
  • IXML_INVALID_CHARACTER_ERR: qualifiedName contains +an invalid character. +
  • IXML_NAMESPACE_ERR: Either the qualifiedName or +namespaceURI is malformed. Refer to the DOM2-Core for +possible reasons. +
  • IXML_INSUFFICIENT_MEMORY: Not enough free memory exist +to complete the operation. +
  • IXML_FAILED: The operation could not be completed. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_setAttributeNode.html b/docs/dist/html/ixml/ixmlElement_setAttributeNode.html new file mode 100644 index 0000000..9e2d1a9 --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_setAttributeNode.html @@ -0,0 +1,40 @@ + + + + + EXPORT_SPEC int ixmlElement_setAttributeNode + + + + +

EXPORT_SPEC int ixmlElement_setAttributeNode

(IXML_Element* element,
  IXML_Attr* newAttr,
  IXML_Attr** rtAttr )

Adds a new attribute node to an Element.
+ + +
+

Documentation

+
Adds a new attribute node to an Element. If an attribute already +exists with newAttr as a name, it will be replaced with the +new one and the old one will be returned in rtAttr. + +

+
Parameters:
element - The Element in which to add the new +attribute. +
newAttr - The new Attr to add. +
rtAttr - A pointer to an Attr where the old +Attr will be stored. This will have +a NULL if no prior node +existed.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either element or +newAttr is NULL. +
  • IXML_WRONG_DOCUMENT_ERR: newAttr does not belong +to the same one as element. +
  • IXML_INUSE_ATTRIBUTE_ERR: newAttr is already +an attribute of another Element. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlElement_setAttributeNodeNS.html b/docs/dist/html/ixml/ixmlElement_setAttributeNodeNS.html new file mode 100644 index 0000000..c0e7761 --- /dev/null +++ b/docs/dist/html/ixml/ixmlElement_setAttributeNodeNS.html @@ -0,0 +1,39 @@ + + + + + EXPORT_SPEC int ixmlElement_setAttributeNodeNS + + + + +

EXPORT_SPEC int ixmlElement_setAttributeNodeNS

(IXML_Element* element,
  IXML_Attr* newAttr,
  IXML_Attr** rcAttr )

Adds a new attribute node.
+ + +
+

Documentation

+
Adds a new attribute node. If an attribute with the same local name +and namespace URI already exists in the Element, the existing +attribute node is replaced with newAttr and the old returned in +rcAttr. + +

+
Parameters:
element - The Element in which to add the +attribute node. +
newAttr - The new Attr to add. +
rcAttr - A pointer to the replaced Attr, if +it exists.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either element or +newAttr is NULL. +
  • IXML_WRONG_DOCUMENT_ERR: newAttr does not belong +to the same document as element. +
  • IXML_INUSE_ATTRIBUTE_ERR: newAttr already is an +attribute of another Element. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlFreeDOMString.html b/docs/dist/html/ixml/ixmlFreeDOMString.html new file mode 100644 index 0000000..ecd6d92 --- /dev/null +++ b/docs/dist/html/ixml/ixmlFreeDOMString.html @@ -0,0 +1,23 @@ + + + + + EXPORT_SPEC void ixmlFreeDOMString + + + + +

EXPORT_SPEC void ixmlFreeDOMString

(DOMString buf )

Frees a DOMString.
+ + +
+

Documentation

+
Frees a DOMString. + +

+
Parameters:
buf - The DOMString to free.
Returns:
[void] This function does not return a value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlLoadDocument.html b/docs/dist/html/ixml/ixmlLoadDocument.html new file mode 100644 index 0000000..fe7e907 --- /dev/null +++ b/docs/dist/html/ixml/ixmlLoadDocument.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC IXML_Document* ixmlLoadDocument + + + + +

EXPORT_SPEC IXML_Document* ixmlLoadDocument

(char* xmlFile )

Parses an XML text file converting it into an IXML DOM representation.
+ + +
+

Documentation

+
Parses an XML text file converting it into an IXML DOM representation. + +

+
Parameters:
xmlFile - The filename of the XML text to convert to a +Document.
Returns:
[Document*] A Document if the file correctly parses or +NULL on an error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlLoadDocumentEx.html b/docs/dist/html/ixml/ixmlLoadDocumentEx.html new file mode 100644 index 0000000..9b83e29 --- /dev/null +++ b/docs/dist/html/ixml/ixmlLoadDocumentEx.html @@ -0,0 +1,37 @@ + + + + + EXPORT_SPEC int ixmlLoadDocumentEx + + + + +

EXPORT_SPEC int ixmlLoadDocumentEx

(char* xmlFile,
  IXML_Document** doc )

Parses an XML text file converting it into an IXML DOM representation.
+ + +
+

Documentation

+
Parses an XML text file converting it into an IXML DOM representation. + +

The ixmlLoadDocumentEx API differs from the ixmlLoadDocument +API in that it returns a an error code representing the actual failure +rather than just NULL. + +

+
Parameters:
xmlFile - The filename of the XML text to convert to a +Document. +
doc - A pointer to the Document if file correctly +parses or NULL on an error.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: The xmlFile is not a valid +pointer. +
  • IXML_INSUFFICIENT_MEMORY: Not enough free memory exists +to complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNamedNodeMap_free.html b/docs/dist/html/ixml/ixmlNamedNodeMap_free.html new file mode 100644 index 0000000..1eaeee3 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNamedNodeMap_free.html @@ -0,0 +1,24 @@ + + + + + EXPORT_SPEC void ixmlNamedNodeMap_free + + + + +

EXPORT_SPEC void ixmlNamedNodeMap_free

(IXML_NamedNodeMap* nnMap )

Frees a NamedNodeMap.
+ + +
+

Documentation

+
Frees a NamedNodeMap. The Nodes inside the map are not +freed, just the NamedNodeMap object. + +

+
Parameters:
nnMap - The NamedNodeMap to free.
Returns:
[void] This function does not return a value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNamedNodeMap_getLength.html b/docs/dist/html/ixml/ixmlNamedNodeMap_getLength.html new file mode 100644 index 0000000..2a75c2d --- /dev/null +++ b/docs/dist/html/ixml/ixmlNamedNodeMap_getLength.html @@ -0,0 +1,24 @@ + + + + + EXPORT_SPEC unsigned long ixmlNamedNodeMap_getLength + + + + +

EXPORT_SPEC unsigned long ixmlNamedNodeMap_getLength

(IXML_NamedNodeMap* nnMap )

Returns the number of items contained in this NamedNodeMap.
+ + +
+

Documentation

+
Returns the number of items contained in this NamedNodeMap. + +

+
Parameters:
nnMap - The NamedNodeMap from which to retrieve +the size.
Returns:
[unsigned long] The number of nodes in this map. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNamedNodeMap_getNamedItem.html b/docs/dist/html/ixml/ixmlNamedNodeMap_getNamedItem.html new file mode 100644 index 0000000..5fe0e29 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNamedNodeMap_getNamedItem.html @@ -0,0 +1,24 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_getNamedItem + + + + +

EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_getNamedItem

(IXML_NamedNodeMap* nnMap,
  DOMString name )

Retrieves a Node from the NamedNodeMap by name.
+ + +
+

Documentation

+
Retrieves a Node from the NamedNodeMap by name. + +

+
Parameters:
nnMap - The NamedNodeMap to search. +
name - The name of the Node to find.
Returns:
[Node*] A Node or NULL if there is an error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNamedNodeMap_getNamedItemNS.html b/docs/dist/html/ixml/ixmlNamedNodeMap_getNamedItemNS.html new file mode 100644 index 0000000..c7a653b --- /dev/null +++ b/docs/dist/html/ixml/ixmlNamedNodeMap_getNamedItemNS.html @@ -0,0 +1,30 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_getNamedItemNS + + + + +

EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_getNamedItemNS

(IXML_NamedNodeMap* nnMap,
  DOMString* namespaceURI,
  DOMString localName )

Retrieves a Node from a NamedNodeMap specified by namespace URI and local name.
+ + +
+

Documentation

+
Retrieves a Node from a NamedNodeMap specified by +namespace URI and local name. + +

+
Parameters:
nnMap - The NamedNodeMap from which to +remove the Node. +
namespaceURI - The namespace URI of the Node to +remove. +
localName - The local name of the Node to +remove.
Returns:
[Node*] A pointer to the Node, if found, or NULL if +it wasn't +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNamedNodeMap_item.html b/docs/dist/html/ixml/ixmlNamedNodeMap_item.html new file mode 100644 index 0000000..e0d2479 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNamedNodeMap_item.html @@ -0,0 +1,27 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_item + + + + +

EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_item

(IXML_NamedNodeMap* nnMap,
  unsigned long index )

Retrieves a Node from a NamedNodeMap specified by a numerical index.
+ + +
+

Documentation

+
Retrieves a Node from a NamedNodeMap specified by a +numerical index. + +

+
Parameters:
nnMap - The NamedNodeMap from which to remove the +Node. +
index - The index into the map to remove.
Returns:
[Node*] A pointer to the Node, if found, or NULL if +it wasn't. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNamedNodeMap_removeNamedItem.html b/docs/dist/html/ixml/ixmlNamedNodeMap_removeNamedItem.html new file mode 100644 index 0000000..f1ec7ca --- /dev/null +++ b/docs/dist/html/ixml/ixmlNamedNodeMap_removeNamedItem.html @@ -0,0 +1,26 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_removeNamedItem + + + + +

EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_removeNamedItem

(IXML_NamedNodeMap* nnMap,
  DOMString name )

Removes a Node from a NamedNodeMap specified by name.
+ + +
+

Documentation

+
Removes a Node from a NamedNodeMap specified by name. + +

+
Parameters:
nnMap - The NamedNodeMap from which to +remove the item. +
name - The name of the item to remove.
Returns:
[Node*] A pointer to the Node, if found, or NULL if +it wasn't. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNamedNodeMap_removeNamedItemNS.html b/docs/dist/html/ixml/ixmlNamedNodeMap_removeNamedItemNS.html new file mode 100644 index 0000000..2226a2b --- /dev/null +++ b/docs/dist/html/ixml/ixmlNamedNodeMap_removeNamedItemNS.html @@ -0,0 +1,30 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_removeNamedItemNS + + + + +

EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_removeNamedItemNS

(IXML_NamedNodeMap* nnMap,
  DOMString namespaceURI,
  DOMString localName )

Removes a Node from a NamedNodeMap specified by namespace URI and local name.
+ + +
+

Documentation

+
Removes a Node from a NamedNodeMap specified by +namespace URI and local name. + +

+
Parameters:
nnMap - The NamedNodeMap from which to +remove the Node. +
namespaceURI - The namespace URI of the Node +to remove. +
localName - The local name of the Node to +remove.
Returns:
[Node*] A pointer to the Node, if found, or NULL if +it wasn't. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNamedNodeMap_setNamedItem.html b/docs/dist/html/ixml/ixmlNamedNodeMap_setNamedItem.html new file mode 100644 index 0000000..6088601 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNamedNodeMap_setNamedItem.html @@ -0,0 +1,29 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_setNamedItem + + + + +

EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_setNamedItem

(IXML_NamedNodeMap* nnMap,
  IXML_Node* arg )

Adds a new Node to the NamedNodeMap using the Node name attribute.
+ + +
+

Documentation

+
Adds a new Node to the NamedNodeMap using the Node +name attribute. + +

+
Parameters:
nnMap - The NamedNodeMap in which to add the +new Node. +
arg - The new Node to add to the +NamedNodeMap.
Returns:
[Node*] The old Node if the new Node replaces it or +NULL if the Node was not in the +NamedNodeMap before. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNamedNodeMap_setNamedItemNS.html b/docs/dist/html/ixml/ixmlNamedNodeMap_setNamedItemNS.html new file mode 100644 index 0000000..6f7d4b6 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNamedNodeMap_setNamedItemNS.html @@ -0,0 +1,28 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_setNamedItemNS + + + + +

EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_setNamedItemNS

(IXML_NamedNodeMap* nnMap,
  IXML_Node* arg )

Adds a new Node to the NamedNodeMap using the Node local name and namespace URI attributes.
+ + +
+

Documentation

+
Adds a new Node to the NamedNodeMap using the Node +local name and namespace URI attributes. + +

+
Parameters:
nnMap - The NamedNodeMap in which to add +the Node. +
arg - The Node to add to the map.
Returns:
[Node*] The old Node if the new Node replaces it or +NULL if the Node was not in the +NamedNodeMap before. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNodeList_free.html b/docs/dist/html/ixml/ixmlNodeList_free.html new file mode 100644 index 0000000..10f0f90 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNodeList_free.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC void ixmlNodeList_free + + + + +

EXPORT_SPEC void ixmlNodeList_free

(IXML_NodeList* nList )

Frees a NodeList object.
+ + +
+

Documentation

+
Frees a NodeList object. Since the underlying Nodes are +references, they are not freed using this operating. This only +frees the NodeList object. + +

+
Parameters:
nList - The NodeList to free.
Returns:
[void] This function does not return a value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNodeList_item.html b/docs/dist/html/ixml/ixmlNodeList_item.html new file mode 100644 index 0000000..9f01cf2 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNodeList_item.html @@ -0,0 +1,27 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNodeList_item + + + + +

EXPORT_SPEC IXML_Node* ixmlNodeList_item

(IXML_NodeList* nList,
  unsigned long index )

Retrieves a Node from a NodeList specified by a numerical index.
+ + +
+

Documentation

+
Retrieves a Node from a NodeList specified by a +numerical index. + +

+
Parameters:
nList - The NodeList from which to retrieve the +Node. +
index - The index into the NodeList to retrieve.
Returns:
[Node*] A pointer to a Node or NULL if there was an +error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNodeList_length.html b/docs/dist/html/ixml/ixmlNodeList_length.html new file mode 100644 index 0000000..50f5787 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNodeList_length.html @@ -0,0 +1,24 @@ + + + + + EXPORT_SPEC unsigned long ixmlNodeList_length + + + + +

EXPORT_SPEC unsigned long ixmlNodeList_length

(IXML_NodeList* nList )

Returns the number of Nodes in a NodeList.
+ + +
+

Documentation

+
Returns the number of Nodes in a NodeList. + +

+
Parameters:
nList - The NodeList for which to retrieve the +number of Nodes.
Returns:
[unsigned long] The number of Nodes in the NodeList. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_appendChild.html b/docs/dist/html/ixml/ixmlNode_appendChild.html new file mode 100644 index 0000000..d3a3b70 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_appendChild.html @@ -0,0 +1,36 @@ + + + + + EXPORT_SPEC int ixmlNode_appendChild + + + + +

EXPORT_SPEC int ixmlNode_appendChild

(IXML_Node* nodeptr,
  IXML_Node* newChild )

Appends a child Node to the list of children of a Node.
+ + +
+

Documentation

+
Appends a child Node to the list of children of a Node. If +newChild is already in the tree, it is removed first. + +

+
Parameters:
nodeptr - The Node in which to append the new child. +
newChild - The new child to append.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either nodeptr or +newChild is NULL. +
  • IXML_HIERARCHY_REQUEST_ERR: newChild is of a type +that cannot be added as a child of nodeptr or +newChild is an ancestor of nodeptr. +
  • IXML_WRONG_DOCUMENT_ERR: newChild was created from +a different document than nodeptr. +
  • IXML_NO_MODIFICATION_ALLOWED_ERR: nodeptr is a +read-only Node. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_cloneNode.html b/docs/dist/html/ixml/ixmlNode_cloneNode.html new file mode 100644 index 0000000..b9391a8 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_cloneNode.html @@ -0,0 +1,28 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNode_cloneNode + + + + +

EXPORT_SPEC IXML_Node* ixmlNode_cloneNode

(IXML_Node* nodeptr,
  BOOL deep )

Clones a Node.
+ + +
+

Documentation

+
Clones a Node. The new Node does not have a parent. The +deep parameter controls whether the subtree of the Node is +also cloned. For details on cloning specific types of Nodes, +refer to the DOM2-Core recommendation. + +

+
Parameters:
nodeptr - The Node to clone. +
deep - TRUE to clone the subtree also or FALSE +to clone only nodeptr.
Returns:
[Node*] A clone of nodeptr or NULL. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_free.html b/docs/dist/html/ixml/ixmlNode_free.html new file mode 100644 index 0000000..4c7602f --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_free.html @@ -0,0 +1,23 @@ + + + + + EXPORT_SPEC void ixmlNode_free + + + + +

EXPORT_SPEC void ixmlNode_free

(IXML_Node* IXML_Node )

Frees a Node and all Nodes in its subtree.
+ + +
+

Documentation

+
Frees a Node and all Nodes in its subtree. + +

+
Parameters:
IXML_Node - The Node to free.
Returns:
[void] This function does not return a value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getAttributes.html b/docs/dist/html/ixml/ixmlNode_getAttributes.html new file mode 100644 index 0000000..c6e97b7 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getAttributes.html @@ -0,0 +1,26 @@ + + + + + EXPORT_SPEC IXML_NamedNodeMap* ixmlNode_getAttributes + + + + +

EXPORT_SPEC IXML_NamedNodeMap* ixmlNode_getAttributes

(IXML_Node* nodeptr )

Retrieves the attributes of a Node, if it is an Element node, in a NamedNodeMap structure.
+ + +
+

Documentation

+
Retrieves the attributes of a Node, if it is an Element node, +in a NamedNodeMap structure. + +

+
Parameters:
nodeptr - The Node from which to retrieve the +attributes.
Returns:
[NamedNodeMap*] A NamedNodeMap of the attributes or +NULL. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getChildNodes.html b/docs/dist/html/ixml/ixmlNode_getChildNodes.html new file mode 100644 index 0000000..d69acbb --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getChildNodes.html @@ -0,0 +1,26 @@ + + + + + EXPORT_SPEC IXML_NodeList* ixmlNode_getChildNodes + + + + +

EXPORT_SPEC IXML_NodeList* ixmlNode_getChildNodes

(IXML_Node* nodeptr )

Retrieves the list of children of a Node in a NodeList structure.
+ + +
+

Documentation

+
Retrieves the list of children of a Node in a NodeList +structure. If a Node has no children, ixmlNode_getChildNodes +returns a NodeList structure that contains no Nodes. + +

+
Parameters:
nodeptr - The Node from which to retrieve the +children.
Returns:
[NodeList*] A NodeList of the children of the Node. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getFirstChild.html b/docs/dist/html/ixml/ixmlNode_getFirstChild.html new file mode 100644 index 0000000..0d9d43b --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getFirstChild.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNode_getFirstChild + + + + +

EXPORT_SPEC IXML_Node* ixmlNode_getFirstChild

(IXML_Node* nodeptr )

Retrieves the first child Node of a Node.
+ + +
+

Documentation

+
Retrieves the first child Node of a Node. + +

+
Parameters:
nodeptr - The Node from which to retrieve the first +child.
Returns:
[Node*] A pointer to the first child Node or NULL +if the Node does not have any children. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getLastChild.html b/docs/dist/html/ixml/ixmlNode_getLastChild.html new file mode 100644 index 0000000..87a2549 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getLastChild.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNode_getLastChild + + + + +

EXPORT_SPEC IXML_Node* ixmlNode_getLastChild

(IXML_Node* nodeptr )

Retrieves the last child Node of a Node.
+ + +
+

Documentation

+
Retrieves the last child Node of a Node. + +

+
Parameters:
nodeptr - The Node from which to retrieve the last +child.
Returns:
[Node*] A pointer to the last child Node or NULL if +the Node does not have any children. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getLocalName.html b/docs/dist/html/ixml/ixmlNode_getLocalName.html new file mode 100644 index 0000000..d260bda --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getLocalName.html @@ -0,0 +1,29 @@ + + + + + EXPORT_SPEC const DOMString ixmlNode_getLocalName + + + + +

EXPORT_SPEC const DOMString ixmlNode_getLocalName

(IXML_Node* nodeptr )

Retrieves the local name of a Node, if present.
+ + +
+

Documentation

+
Retrieves the local name of a Node, if present. The local name is +the tag name without the namespace prefix. Only Nodes of type +eELEMENT_NODE or eATTRIBUTE_NODE can have a local name. +{\Bf Node}s created through the Document interface will only +contain a local name if created using ixmlDocument_createElementNS. + +

+
Parameters:
nodeptr - The Node from which to retrieve the local +name.
Returns:
[const DOMString] A DOMString representing the local name +of the Element or NULL. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getNamespaceURI.html b/docs/dist/html/ixml/ixmlNode_getNamespaceURI.html new file mode 100644 index 0000000..fd312d5 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getNamespaceURI.html @@ -0,0 +1,29 @@ + + + + + EXPORT_SPEC const DOMString ixmlNode_getNamespaceURI + + + + +

EXPORT_SPEC const DOMString ixmlNode_getNamespaceURI

(IXML_Node* nodeptr )

Retrieves the namespace URI for a Node as a DOMString.
+ + +
+

Documentation

+
Retrieves the namespace URI for a Node as a DOMString. Only +Nodes of type eELEMENT_NODE or eATTRIBUTE_NODE can +have a namespace URI. Nodes created through the Document +interface will only contain a namespace if created using +ixmlDocument_createElementNS. + +

+
Parameters:
nodeptr - The Node for which to retrieve the +namespace.
Returns:
[const DOMString] A DOMString representing the URI of the +namespace or NULL. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getNextSibling.html b/docs/dist/html/ixml/ixmlNode_getNextSibling.html new file mode 100644 index 0000000..b534cf5 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getNextSibling.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNode_getNextSibling + + + + +

EXPORT_SPEC IXML_Node* ixmlNode_getNextSibling

(IXML_Node* nodeptr )

Retrieves the sibling Node immediately following this Node.
+ + +
+

Documentation

+
Retrieves the sibling Node immediately following this Node. + +

+
Parameters:
nodeptr - The Node from which to retrieve the next +sibling.
Returns:
[Node*] A pointer to the next sibling Node or NULL +if no such Node exists. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getNodeName.html b/docs/dist/html/ixml/ixmlNode_getNodeName.html new file mode 100644 index 0000000..c7e4296 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getNodeName.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC const DOMString ixmlNode_getNodeName + + + + +

EXPORT_SPEC const DOMString ixmlNode_getNodeName

(IXML_Node* nodeptr )

Returns the name of the Node, depending on what type of Node it is, in a read-only string.
+ + +
+

Documentation

+
Returns the name of the Node, depending on what type of +Node it is, in a read-only string. Refer to the table in the +DOM2-Core for a description of the node names for various interfaces. + +

+
Parameters:
nodeptr - Pointer to the node to retrieve the name.
Returns:
[const DOMString] A constant DOMString of the node name. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getNodeType.html b/docs/dist/html/ixml/ixmlNode_getNodeType.html new file mode 100644 index 0000000..e6e86b2 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getNodeType.html @@ -0,0 +1,39 @@ + + + + + EXPORT_SPEC unsigned short ixmlNode_getNodeType + + + + +

EXPORT_SPEC unsigned short ixmlNode_getNodeType

(IXML_Node* nodeptr )

Retrieves the type of a Node.
+ + +
+

Documentation

+
Retrieves the type of a Node. The defined Node constants +are: +
    +
  • eATTRIBUTE_NODE +
  • eCDATA_SECTION_NODE +
  • eCOMMENT_NODE +
  • eDOCUMENT_FRAGMENT_NODE +
  • eDOCUMENT_NODE +
  • eDOCUMENT_TYPE_NODE +
  • eELEMENT_NODE +
  • eENTITY_NODE +
  • eENTITY_REFERENCE_NODE +
  • eNOTATION_NODE +
  • ePROCESSING_INSTRUCTION_NODE +
  • eTEXT_NODE +
+ +

+
Parameters:
nodeptr - The Node from which to retrieve the type.
Returns:
[const unsigned short] An integer representing the type of the +Node. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getNodeValue.html b/docs/dist/html/ixml/ixmlNode_getNodeValue.html new file mode 100644 index 0000000..7e1d5d4 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getNodeValue.html @@ -0,0 +1,24 @@ + + + + + EXPORT_SPEC DOMString ixmlNode_getNodeValue + + + + +

EXPORT_SPEC DOMString ixmlNode_getNodeValue

(IXML_Node* nodeptr )

Returns the value of the Node as a string.
+ + +
+

Documentation

+
Returns the value of the Node as a string. Note that this string +is not a copy and modifying it will modify the value of the Node. + +

+
Parameters:
nodeptr - Pointer to the Node to retrieve the value.
Returns:
[DOMString] A DOMString of the Node value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getOwnerDocument.html b/docs/dist/html/ixml/ixmlNode_getOwnerDocument.html new file mode 100644 index 0000000..de9abec --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getOwnerDocument.html @@ -0,0 +1,28 @@ + + + + + EXPORT_SPEC IXML_Document* ixmlNode_getOwnerDocument + + + + +

EXPORT_SPEC IXML_Document* ixmlNode_getOwnerDocument

(IXML_Node* nodeptr )

Retrieves the document object associated with this Node.
+ + +
+

Documentation

+
Retrieves the document object associated with this Node. This +owner document Node allows other Nodes to be created in the +context of this document. Note that Document nodes do not have +an owner document. + +

+
Parameters:
nodeptr - The Node from which to retrieve the +owner document.
Returns:
[Document*] A pointer to the owning Document or +NULL, if the Node does not have an owner. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getParentNode.html b/docs/dist/html/ixml/ixmlNode_getParentNode.html new file mode 100644 index 0000000..7e4b542 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getParentNode.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNode_getParentNode + + + + +

EXPORT_SPEC IXML_Node* ixmlNode_getParentNode

(IXML_Node* nodeptr )

Retrieves the parent Node for a Node.
+ + +
+

Documentation

+
Retrieves the parent Node for a Node. + +

+
Parameters:
nodeptr - The Node from which to retrieve the +parent.
Returns:
[Node*] A pointer to the parent Node or NULL if the +Node has no parent. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getPrefix.html b/docs/dist/html/ixml/ixmlNode_getPrefix.html new file mode 100644 index 0000000..224667e --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getPrefix.html @@ -0,0 +1,28 @@ + + + + + EXPORT_SPEC DOMString ixmlNode_getPrefix + + + + +

EXPORT_SPEC DOMString ixmlNode_getPrefix

(IXML_Node* nodeptr )

Retrieves the namespace prefix, if present.
+ + +
+

Documentation

+
Retrieves the namespace prefix, if present. The prefix is the name +used as an alias for the namespace URI for this element. Only +Nodes of type eELEMENT_NODE or eATTRIBUTE_NODE can have +a prefix. Nodes created through the Document interface will +only contain a prefix if created using ixmlDocument_createElementNS. + +

+
Parameters:
nodeptr - The Node from which to retrieve the prefix.
Returns:
[DOMString] A DOMString representing the namespace prefix +or NULL. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_getPreviousSibling.html b/docs/dist/html/ixml/ixmlNode_getPreviousSibling.html new file mode 100644 index 0000000..0eba688 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_getPreviousSibling.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC IXML_Node* ixmlNode_getPreviousSibling + + + + +

EXPORT_SPEC IXML_Node* ixmlNode_getPreviousSibling

(IXML_Node* nodeptr )

Retrieves the sibling Node immediately preceding this Node.
+ + +
+

Documentation

+
Retrieves the sibling Node immediately preceding this Node. + +

+
Parameters:
nodeptr - The Node for which to retrieve the +previous sibling.
Returns:
[Node*] A pointer to the previous sibling Node or +NULL if no such Node exists. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_hasAttributes.html b/docs/dist/html/ixml/ixmlNode_hasAttributes.html new file mode 100644 index 0000000..ccb3bf4 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_hasAttributes.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC BOOL ixmlNode_hasAttributes + + + + +

EXPORT_SPEC BOOL ixmlNode_hasAttributes

(IXML_Node* node )

Queries whether this Node has attributes.
+ + +
+

Documentation

+
Queries whether this Node has attributes. Note that only +Element nodes have attributes. + +

+
Parameters:
node - The Node to query for attributes.
Returns:
[BOOL] TRUE if the Node has attributes otherwise +FALSE. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_hasChildNodes.html b/docs/dist/html/ixml/ixmlNode_hasChildNodes.html new file mode 100644 index 0000000..a22e36c --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_hasChildNodes.html @@ -0,0 +1,24 @@ + + + + + EXPORT_SPEC BOOL ixmlNode_hasChildNodes + + + + +

EXPORT_SPEC BOOL ixmlNode_hasChildNodes

(IXML_Node* nodeptr )

Queries whether or not a Node has children.
+ + +
+

Documentation

+
Queries whether or not a Node has children. + +

+
Parameters:
nodeptr - The Node to query for children.
Returns:
[BOOL] TRUE if the Node has one or more children +otherwise FALSE. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_insertBefore.html b/docs/dist/html/ixml/ixmlNode_insertBefore.html new file mode 100644 index 0000000..8a97aea --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_insertBefore.html @@ -0,0 +1,49 @@ + + + + + EXPORT_SPEC int ixmlNode_insertBefore + + + + +

EXPORT_SPEC int ixmlNode_insertBefore

(IXML_Node* nodeptr,
  IXML_Node* newChild,
  IXML_Node* refChild )

Inserts a new child Node before the existing child Node.
+ + +
+

Documentation

+
Inserts a new child Node before the existing child Node. +refChild can be NULL, which inserts newChild at the +end of the list of children. Note that the Node (or Nodes) +in newChild must already be owned by the owner document (or have no +owner at all) of nodeptr for insertion. If not, the Node +(or Nodes) must be imported into the document using +ixmlDocument_importNode. If newChild is already in the tree, +it is removed first. + +

+
Parameters:
nodeptr - The parent of the Node before which to +insert the new child. +
newChild - The Node to insert into the tree. +
refChild - The reference child where the new Node +should be inserted. The new Node will +appear directly before the reference child.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either nodeptr or +newChild is NULL. +
  • IXML_HIERARCHY_REQUEST_ERR: The type of the Node +does not allow children of the type of newChild. +
  • IXML_WRONG_DOCUMENT_ERR: newChild has an owner +document that does not match the owner of nodeptr. +
  • IXML_NO_MODIFICATION_ALLOWED_ERR: nodeptr is +read-only or the parent of the Node being inserted is +read-only. +
  • IXML_NOT_FOUND_ERR: refChild is not a child of +nodeptr. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_removeChild.html b/docs/dist/html/ixml/ixmlNode_removeChild.html new file mode 100644 index 0000000..e30ba51 --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_removeChild.html @@ -0,0 +1,38 @@ + + + + + EXPORT_SPEC int ixmlNode_removeChild + + + + +

EXPORT_SPEC int ixmlNode_removeChild

(IXML_Node* nodeptr,
  IXML_Node* oldChild,
  IXML_Node** returnNode )

Removes a child from the list of children of a Node.
+ + +
+

Documentation

+
Removes a child from the list of children of a Node. +returnNode will contain the oldChild Node, +appropriately removed from the tree (i.e. it will no longer have an +owner document). + +

+
Parameters:
nodeptr - The parent of the child to remove. +
oldChild - The child Node to remove. +
returnNode - Pointer to a Node to place the removed +oldChild Node.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: Either nodeptr or +oldChild is NULL. +
  • IXML_NO_MODIFICATION_ALLOWED_ERR: nodeptr or its +parent is read-only. +
  • IXML_NOT_FOUND_ERR: oldChild is not among the +children of nodeptr. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_replaceChild.html b/docs/dist/html/ixml/ixmlNode_replaceChild.html new file mode 100644 index 0000000..70a05ea --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_replaceChild.html @@ -0,0 +1,46 @@ + + + + + EXPORT_SPEC int ixmlNode_replaceChild + + + + +

EXPORT_SPEC int ixmlNode_replaceChild

(IXML_Node* nodeptr,
  IXML_Node* newChild,
  IXML_Node* oldChild,
  IXML_Node** returnNode )

Replaces an existing child Node with a new child Node in the list of children of a Node.
+ + +
+

Documentation

+
Replaces an existing child Node with a new child Node in +the list of children of a Node. If newChild is already in +the tree, it will first be removed. returnNode will contain the +oldChild Node, appropriately removed from the tree (i.e. it +will no longer have an owner document). + +

+
Parameters:
nodeptr - The parent of the Node which contains the +child to replace. +
newChild - The child with which to replace oldChild. +
oldChild - The child to replace with newChild. +
returnNode - Pointer to a Node to place the removed +oldChild Node.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMTER: Either nodeptr, +newChild, or oldChild is NULL. +
  • IXML_HIERARCHY_REQUEST_ERR: The newChild is not +a type of Node that can be inserted into this tree or +newChild is an ancestor of nodePtr. +
  • IXML_WRONG_DOCUMENT_ERR: newChild was created from +a different document than nodeptr. +
  • IXML_NO_MODIFICATION_ALLOWED_ERR: nodeptr or +its parent is read-only. +
  • IXML_NOT_FOUND_ERR: oldChild is not a child of +nodeptr. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNode_setNodeValue.html b/docs/dist/html/ixml/ixmlNode_setNodeValue.html new file mode 100644 index 0000000..7bbd7ca --- /dev/null +++ b/docs/dist/html/ixml/ixmlNode_setNodeValue.html @@ -0,0 +1,33 @@ + + + + + EXPORT_SPEC int ixmlNode_setNodeValue + + + + +

EXPORT_SPEC int ixmlNode_setNodeValue

(IXML_Node* nodeptr,
  char* newNodeValue )

Assigns a new value to a Node.
+ + +
+

Documentation

+
Assigns a new value to a Node. The newNodeValue string is +duplicated and stored in the Node so that the original does not +have to persist past this call. + +

+
Parameters:
nodeptr - The Node to which to assign a new value. +
newNodeValue - The new value of the Node.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: The Node* is not a valid +pointer. +
  • IXML_INSUFFICIENT_MEMORY: Not enough free memory exists +to complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlNodetoString.html b/docs/dist/html/ixml/ixmlNodetoString.html new file mode 100644 index 0000000..f00ae2a --- /dev/null +++ b/docs/dist/html/ixml/ixmlNodetoString.html @@ -0,0 +1,32 @@ + + + + + EXPORT_SPEC DOMString ixmlNodetoString + + + + +

EXPORT_SPEC DOMString ixmlNodetoString

(IXML_Node* doc )

Renders a Node and all sub-elements into an XML text representation.
+ + +
+

Documentation

+
Renders a Node and all sub-elements into an XML text +representation. The caller is required to free the DOMString +returned from this function using ixmlFreeDOMString when it +is no longer required. + +

Note that this function can be used for any Node-derived +interface. The difference between ixmlNodetoString and +ixmlDocumenttoString is ixmlNodetoString does not include +the XML prolog, it only produces XML elements. + +

+
Parameters:
doc - The root of the Node tree to render to XML text.
Returns:
[DOMString] A DOMString with the XML text representation +of the DOM tree or NULL on an error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlParseBuffer.html b/docs/dist/html/ixml/ixmlParseBuffer.html new file mode 100644 index 0000000..ded70a7 --- /dev/null +++ b/docs/dist/html/ixml/ixmlParseBuffer.html @@ -0,0 +1,25 @@ + + + + + EXPORT_SPEC IXML_Document* ixmlParseBuffer + + + + +

EXPORT_SPEC IXML_Document* ixmlParseBuffer

(char* buffer )

Parses an XML text buffer converting it into an IXML DOM representation.
+ + +
+

Documentation

+
Parses an XML text buffer converting it into an IXML DOM representation. + +

+
Parameters:
buffer - The buffer that contains the XML text to convert to a +Document.
Returns:
[Document*] A Document if the buffer correctly parses or +NULL on an error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlParseBufferEx.html b/docs/dist/html/ixml/ixmlParseBufferEx.html new file mode 100644 index 0000000..9f4d9ed --- /dev/null +++ b/docs/dist/html/ixml/ixmlParseBufferEx.html @@ -0,0 +1,37 @@ + + + + + EXPORT_SPEC int ixmlParseBufferEx + + + + +

EXPORT_SPEC int ixmlParseBufferEx

(char* buffer,
  IXML_Document** doc )

Parses an XML text buffer converting it into an IXML DOM representation.
+ + +
+

Documentation

+
Parses an XML text buffer converting it into an IXML DOM representation. + +

The ixmlParseBufferEx API differs from the ixmlParseBuffer +API in that it returns an error code representing the actual failure +rather than just NULL. + +

+
Parameters:
buffer - The buffer that contains the XML text to convert to a +Document. +
doc - A point to store the Document if file correctly +parses or NULL on an error.
Returns:
[int] An integer representing one of the following: +
    +
  • IXML_SUCCESS: The operation completed successfully. +
  • IXML_INVALID_PARAMETER: The buffer is not a valid +pointer. +
  • IXML_INSUFFICIENT_MEMORY: Not enough free memory exists +to complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlPrintDocument.html b/docs/dist/html/ixml/ixmlPrintDocument.html new file mode 100644 index 0000000..0341517 --- /dev/null +++ b/docs/dist/html/ixml/ixmlPrintDocument.html @@ -0,0 +1,36 @@ + + + + + DOMString ixmlPrintDocument + + + + +

DOMString ixmlPrintDocument

(IXML_Document* doc)

Renders a Node and all sub-elements into an XML document representation.
+ + +
+

Documentation

+
Renders a Node and all sub-elements into an XML document +representation. The caller is required to free the DOMString +returned from this function using ixmlFreeDOMString when it +is no longer required. + +

Note that this function can be used for any Node-derived +interface. The difference between ixmlPrintDocument and +ixmlPrintNode is ixmlPrintDocument includes the XML prolog +while ixmlPrintNode only produces XML elements. An XML +document is not well formed unless it includes the prolog +and at least one element. + +

This function introduces lots of white space to print the +DOMString in readable format. + +

+
Returns:
[DOMString] A DOMString with the XML document representation +of the DOM tree or NULL on an error.

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlPrintNode.html b/docs/dist/html/ixml/ixmlPrintNode.html new file mode 100644 index 0000000..8ae607a --- /dev/null +++ b/docs/dist/html/ixml/ixmlPrintNode.html @@ -0,0 +1,33 @@ + + + + + DOMString ixmlPrintNode + + + + +

DOMString ixmlPrintNode

(IXML_Node* doc )

Renders a Node and all sub-elements into an XML text representation.
+ + +
+

Documentation

+
Renders a Node and all sub-elements into an XML text +representation. The caller is required to free the DOMString +returned from this function using ixmlFreeDOMString when it +is no longer required. + +

Note that this function can be used for any Node-derived +interface. A similar ixmlPrintDocument function is defined +to avoid casting when printing whole documents. This function +introduces lots of white space to print the DOMString in readable +format. + +

+
Parameters:
doc - The root of the Node tree to render to XML text.
Returns:
[DOMString] A DOMString with the XML text representation +of the DOM tree or NULL on an error. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/ixmlRelaxParser.html b/docs/dist/html/ixml/ixmlRelaxParser.html new file mode 100644 index 0000000..abf931f --- /dev/null +++ b/docs/dist/html/ixml/ixmlRelaxParser.html @@ -0,0 +1,27 @@ + + + + + void ixmlRelaxParser + + + + +

void ixmlRelaxParser

(char errorChar)

Makes the XML parser more tolerant to malformed text.
+ + +
+

Documentation

+
Makes the XML parser more tolerant to malformed text. + +

If errorChar is 0 (default), the parser is strict about XML +encoding : invalid UTF-8 sequences or "&" entities are rejected, and +the parsing aborts. +If errorChar is not 0, the parser is relaxed : invalid UTF-8 +characters are replaced by the errorChar, and invalid "&" entities +are left untranslated. The parsing is then allowed to continue.

+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/ixml/toc.html b/docs/dist/html/ixml/toc.html new file mode 100644 index 0000000..39af15b --- /dev/null +++ b/docs/dist/html/ixml/toc.html @@ -0,0 +1,19 @@ + + + + + Table of Contents + + + + +

Table of Contents

+

General stuff

+ +
+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/AboutCallbacks.html b/docs/dist/html/upnp/AboutCallbacks.html new file mode 100644 index 0000000..f51f08b --- /dev/null +++ b/docs/dist/html/upnp/AboutCallbacks.html @@ -0,0 +1,26 @@ + + + + + About Callbacks + + + + +

About Callbacks

+
+The Linux SDK for UPnP Devices contains functions that generate +asynchronous callbacks. To simplify the application callback functions, +these callbacks are executed on a thread owned by the SDK itself. The +SDK executes the application's callback function in a thread +context so the application can allocate memory and preserve the information +it needs. The application can also use standard thread synchronization +methods to ensure data integrity. Due to the possibility of deadlock, the +application cannot call back into the SDK during these callbacks +unless explicitly noted. There is no restriction in calling into the +operating system or any other application interfaces.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/ConstantsStructuresandTypes.html b/docs/dist/html/upnp/ConstantsStructuresandTypes.html new file mode 100644 index 0000000..0f1081d --- /dev/null +++ b/docs/dist/html/upnp/ConstantsStructuresandTypes.html @@ -0,0 +1,79 @@ + + + + + Constants, Structures, and Types + + + + +

Constants, Structures, and Types

+ +
+
+
+ +o +UpnpClient_Handle
Returned when a control point application registers with UpnpRegisterClient. +
+ +o +UpnpDevice_Handle
Returned when a device application registers with UpnpRegisterRootDevice or UpnpRegisterRootDevice2. +
+ +o +UPnP_EventType
The reason code for an event callback. +
+ +o +Upnp_SID[44]
The Upnp_SID holds the subscription identifier for a subscription between a client and a device. +
+ +o +Upnp_SType
Represents the different types of searches that can be performed using the SDK for UPnP Devices API. +
+ +o +Upnp_DescType
Specifies the type of description in UpnpRegisterRootDevice2. +
+ +o +Upnp_Action_Request
Returned as part of a UPNP_CONTROL_ACTION_COMPLETE callback. +
+ +o +Upnp_State_Var_Request
Represents the request for current value of a state variable in a service state table. +
+ +o +Upnp_State_Var_Complete
Represents the reply for the current value of a state variable in an asynchronous call. +
+ +o +Upnp_Event
Returned along with a UPNP_EVENT_RECEIVED callback. +
+ +o +Upnp_Discovery
Returned in a UPNP_DISCOVERY_RESULT callback. +
+ +o +Upnp_Event_Subscribe
Returned along with a UPNP_EVENT_SUBSCRIBE_COMPLETE or UPNP_EVENT_UNSUBSCRIBE_COMPLETE callback. +
+ +o +Upnp_Subscription_Request
Returned along with a UPNP_EVENT_SUBSCRIPTION_REQUEST callback. +
+ +o +UpnpVirtualDirCallbacks
The UpnpVirtualDirCallbacks structure contains the pointers to file-related callback functions a device application can register to virtualize URLs. +
+ +o +(*Upnp_FunPtr)
All callback functions share the same prototype, documented below. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Control.html b/docs/dist/html/upnp/Control.html new file mode 100644 index 0000000..78c748f --- /dev/null +++ b/docs/dist/html/upnp/Control.html @@ -0,0 +1,43 @@ + + + + + Control + + + + +

Control

+ +
+
+
+ +o +UpnpGetServiceVarStatus
UpnpGetServiceVarStatus queries the state of a state variable of a service on another device. +
+ +o +UpnpGetServiceVarStatusAsync
UpnpGetServiceVarStatusAsync queries the state of a variable of a service, generating a callback when the operation is complete. +
+ +o +UpnpSendAction
UpnpSendAction sends a message to change a state variable in a service. +
+ +o +UpnpSendActionEx
UpnpSendActionEx sends a message to change a state variable in a service. +
+ +o +UpnpSendActionAsync
UpnpSendActionAsync sends a message to change a state variable in a service, generating a callback when the operation is complete. +
+ +o +UpnpSendActionExAsync
UpnpSendActionExAsync sends a message to change a state variable in a service, generating a callback when the operation is complete. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/ControlPointHTTPAPI.html b/docs/dist/html/upnp/ControlPointHTTPAPI.html new file mode 100644 index 0000000..07aa59b --- /dev/null +++ b/docs/dist/html/upnp/ControlPointHTTPAPI.html @@ -0,0 +1,67 @@ + + + + + Control Point HTTP API + + + + +

Control Point HTTP API

+ +
+
+
+ +o +UpnpDownloadUrlItem
UpnpDownloadUrlItem downloads a file specified in a URL. +
+ +o +UpnpOpenHttpGet
UpnpOpenHttpGet gets a file specified in a URL. +
+ +o +UpnpOpenHttpGetProxy
UpnpOpenHttpGetProxy gets a file specified in a URL through the specified proxy. +
+ +o +UpnpOpenHttpGetEx
UpnpOpenHttpGetEx gets specified number of bytes from a file specified in the URL. +
+ +o +UpnpReadHttpGet
UpnpReadHttpGet gets specified number of bytes from a file specified in a URL. +
+ +o +UpnpHttpGetProgress
UpnpHttpGetProgress rettrieve progress information of a http-get transfer. +
+ +o +UpnpCancelHttpGet
UpnpCancelHttpGet set the cancel flag of the handle parameter. +
+ +o +UpnpCloseHttpGet
UpnpCloseHttpGet closes the connection and frees memory that was allocated for the handle parameter. +
+ +o +UpnpOpenHttpPost
UpnpOpenHttpPost makes an HTTP POST request message, opens a connection to the server and sends the POST request to the server if the connection to the server succeeds. +
+ +o +UpnpWriteHttpPost
UpnpWriteHttpPost sends a request to a server to copy the contents of a buffer to the URI specified in the UpnpOpenHttpPost call. +
+ +o +UpnpCloseHttpPost
UpnpCloseHttpPost sends and receives any pending data, closes the connection with the server, and frees memory allocated during the UpnpOpenHttpPost call. +
+ +o +UpnpDownloadXmlDoc
UpnpDownloadXmlDoc downloads an XML document specified in a URL. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Discovery.html b/docs/dist/html/upnp/Discovery.html new file mode 100644 index 0000000..e795576 --- /dev/null +++ b/docs/dist/html/upnp/Discovery.html @@ -0,0 +1,27 @@ + + + + + Discovery + + + + +

Discovery

+ +
+
+
+ +o +UpnpSearchAsync
UpnpSearchAsync searches for devices matching the given search target. +
+ +o +UpnpSendAdvertisement
UpnpSendAdvertisement sends out the discovery announcements for all devices and services for a device. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Errorcodes.html b/docs/dist/html/upnp/Errorcodes.html new file mode 100644 index 0000000..78e28d0 --- /dev/null +++ b/docs/dist/html/upnp/Errorcodes.html @@ -0,0 +1,126 @@ + + + + + Error codes + + + + +

Error codes

+
The functions in the SDK API can return a variety of error +codes to describe problems encountered during execution. This section +lists the error codes and provides a brief description of what each error +code means. Refer to the documentation for each function for a +description of what an error code means in that context.
+ +
+
+
+ +o +UPNP_E_SUCCESS [0]
+ +o +UPNP_E_INVALID_HANDLE [-100]
+ +o +UPNP_E_INVALID_PARAM [-101]
+ +o +UPNP_E_OUTOF_HANDLE [-102]
+ +o +UPNP_E_OUTOF_MEMORY [-104]
+ +o +UPNP_E_INIT [-105]
+ +o +UPNP_E_INVALID_DESC [-107]
+ +o +UPNP_E_INVALID_URL [-108]
+ +o +UPNP_E_INVALID_SERVICE [-111]
+ +o +UPNP_E_BAD_RESPONSE [-113]
+ +o +UPNP_E_INVALID_ACTION [-115]
+ +o +UPNP_E_FINISH [-116]
+ +o +UPNP_E_INIT_FAILED [-117]
+ +o +UPNP_E_BAD_HTTPMSG [-119]
+ +o +UPNP_E_ALREADY_REGISTERED [-120]
+ +o +UPNP_E_NETWORK_ERROR [-200]
+ +o +UPNP_E_SOCKET_WRITE [-201]
+ +o +UPNP_E_SOCKET_READ [-202]
+ +o +UPNP_E_SOCKET_BIND [-203]
+ +o +UPNP_E_SOCKET_CONNECT [-204]
+ +o +UPNP_E_OUTOF_SOCKET [-205]
+ +o +UPNP_E_LISTEN [-206]
+ +o +UPNP_E_TIMEDOUT [-207]
+ +o +UPNP_E_SOCKET_ERROR [-208]
+ +o +UPNP_E_CANCELED [-210]
+ +o +UPNP_E_SUBSCRIBE_UNACCEPTED [-301]
+ +o +UPNP_E_UNSUBSCRIBE_UNACCAPTED [-302]
+ +o +UPNP_E_NOTIFY_UNACCEPTED [-303]
+ +o +UPNP_E_INVALID_ARGUMENT [-501]
+ +o +UPNP_E_FILE_NOT_FOUND [-502]
+ +o +UPNP_E_FILE_READ_ERROR [-503]
+ +o +UPNP_E_EXT_NOT_XML [-504]
+ +o +UPNP_E_NOT_FOUND [-507]
+ +o +UPNP_E_INTERNAL_ERROR [-911]
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Eventing.html b/docs/dist/html/upnp/Eventing.html new file mode 100644 index 0000000..45c107a --- /dev/null +++ b/docs/dist/html/upnp/Eventing.html @@ -0,0 +1,67 @@ + + + + + Eventing + + + + +

Eventing

+ +
+
+
+ +o +UpnpAcceptSubscription
UpnpAcceptSubscription accepts a subscription request and sends out the current state of the eventable variables for a service. +
+ +o +UpnpAcceptSubscriptionExt
UpnpAcceptSubscriptionExt is similar to UpnpAcceptSubscription except that it takes a DOM document for the variables to event rather than an array of strings. +
+ +o +UpnpNotify
UpnpNotify sends out an event change notification to all control points subscribed to a particular service. +
+ +o +UpnpNotifyExt
UpnpNotifyExt is similar to UpnpNotify except that it takes a DOM document for the event rather than an array of strings. +
+ +o +UpnpRenewSubscription
UpnpRenewSubscription renews a subscription that is about to expire. +
+ +o +UpnpRenewSubscriptionAsync
UpnpRenewSubscriptionAsync renews a subscription that is about to expire, generating a callback when the operation is complete. +
+ +o +UpnpSetMaxSubscriptions
UpnpSetMaxSubscriptions sets the maximum number of subscriptions accepted per service. +
+ +o +UpnpSetMaxSubscriptionTimeOut
UpnpSetMaxSubscriptionTimeOut sets the maximum time-out accepted for a subscription request or renewal. +
+ +o +UpnpSubscribe
UpnpSubscribe registers a control point to receive event notifications from another device. +
+ +o +UpnpSubscribeAsync
UpnpSubscribeAsync performs the same operation as UpnpSubscribe, but returns immediately and calls the registered callback function when the operation is complete. +
+ +o +UpnpUnSubscribe
UpnpUnSubscribe removes the subscription of a control point from a service previously subscribed to using UpnpSubscribe or UpnpSubscribeAsync. +
+ +o +UpnpUnSubscribeAsync
UpnpUnSubscribeAsync removes a subscription of a control point from a service previously subscribed to using UpnpSubscribe or UpnpSubscribeAsync, generating a callback when the operation is complete. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/General.html b/docs/dist/html/upnp/General.html new file mode 100644 index 0000000..3dbee59 --- /dev/null +++ b/docs/dist/html/upnp/General.html @@ -0,0 +1,16 @@ + + + + + General Bits + + + + +
+
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/InitializationandRegistration.html b/docs/dist/html/upnp/InitializationandRegistration.html new file mode 100644 index 0000000..158c3cd --- /dev/null +++ b/docs/dist/html/upnp/InitializationandRegistration.html @@ -0,0 +1,63 @@ + + + + + Initialization and Registration + + + + +

Initialization and Registration

+ +
+
+
+ +o +UpnpInit
Initializes the Linux SDK for UPnP Devices. +
+ +o +UpnpFinish
Terminates the Linux SDK for UPnP Devices. +
+ +o +UpnpGetServerPort
If '0' is used as the port number in UpnpInit, then this function can be used to retrieve the actual port allocated to the SDK. +
+ +o +UpnpGetServerIpAddress
If NULL is used as the IP address in UpnpInit, then this function can be used to retrieve the actual interface address on which device is running. +
+ +o +UpnpRegisterClient
UpnpRegisterClient registers a control point application with the SDK. +
+ +o +UpnpRegisterRootDevice
UpnpRegisterRootDevice registers a device application with the SDK. +
+ +o +UpnpRegisterRootDevice2
UpnpRegisterRootDevice2 is similar to UpnpRegisterRootDevice, except that it also allows the description document to be specified as a file or a memory buffer. +
+ +o +UpnpUnRegisterClient
UpnpUnRegisterClient unregisters a control point application, unsubscribing all active subscriptions. +
+ +o +UpnpUnRegisterRootDevice
Unregisters a root device registered with UpnpRegisterRootDevice or UpnpRegisterRootDevice2. +
+ +o +UpnpSetContentLength
OBSOLETE METHOD : use UpnpSetMaxContentLength instead. +
+ +o +UpnpSetMaxContentLength
Sets the maximum content-length that the SDK will process on an incoming SOAP requests or responses. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Introduction.html b/docs/dist/html/upnp/Introduction.html new file mode 100644 index 0000000..931db81 --- /dev/null +++ b/docs/dist/html/upnp/Introduction.html @@ -0,0 +1,30 @@ + + + + + Introduction + + + + +

Introduction

+
This document gives a brief description of the Linux SDK for UPnP +Devices API. Section 1 covers the license under which the SDK is +distributed. Section 2 talks about the callback functions used +in many parts of the API. Finally, section 3 details the structures and +functions that comprise the API. + +

The Linux SDK for UPnP Devices version 1.2 supports the following +platforms: +

    +
  • Linux* running on an Intel Architecture processor +
  • Linux running on an Intel StrongARM or XScale processor +
+ +

* Other brands and names are the property of their respective +owners.

+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/License.html b/docs/dist/html/upnp/License.html new file mode 100644 index 0000000..d1668c7 --- /dev/null +++ b/docs/dist/html/upnp/License.html @@ -0,0 +1,45 @@ + + + + + License + + + + +

License

+
+
+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. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/OptionalToolAPIs.html b/docs/dist/html/upnp/OptionalToolAPIs.html new file mode 100644 index 0000000..086a952 --- /dev/null +++ b/docs/dist/html/upnp/OptionalToolAPIs.html @@ -0,0 +1,55 @@ + + + + + Optional Tool APIs + + + + +

Optional Tool APIs

+
The Linux SDK for UPnP Devices contains some additional, optional +utility APIs that can be helpful in writing applications using the +SDK. These additional APIs can be compiled out in order to save code +size in the SDK. Refer to the README for details.
+ +
+
+
+ +o +UpnpResolveURL
UpnpResolveURL combines a base URL and a relative URL into a single absolute URL. +
+ +o +UpnpMakeAction
UpnpMakeAction creates an action request packet based on its input parameters (status variable name and value pair). +
+ +o +UpnpAddToAction
UpnpAddToAction creates an action request packet based on its input parameters (status variable name and value pair). +
+ +o +UpnpMakeActionResponse
UpnpMakeActionResponse creates an action response packet based on its output parameters (status variable name and value pair). +
+ +o +UpnpAddToActionResponse
UpnpAddToActionResponse creates an action response packet based on its output parameters (status variable name and value pair). +
+ +o +UpnpAddToPropertySet
UpnpAddToPropertySet can be used when an application needs to transfer the status of many variables at once. +
+ +o +UpnpCreatePropertySet
UpnpCreatePropertySet creates a property set message packet. +
+ +o +UpnpGetErrorMessage
UpnpGetErrorMessage converts an SDK error code into a string error message suitable for display. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/TheAPI.html b/docs/dist/html/upnp/TheAPI.html new file mode 100644 index 0000000..93766fb --- /dev/null +++ b/docs/dist/html/upnp/TheAPI.html @@ -0,0 +1,43 @@ + + + + + The API + + + + +

The API

+ +
+
+
+ +o +Error codes
+ +o +Constants, Structures, and Types
+ +o +Initialization and Registration
+ +o +Discovery
+ +o +Control
+ +o +Eventing
+ +o +Control Point HTTP API
+ +o +Web Server API
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNPREG_BUF_DESC.html b/docs/dist/html/upnp/UPNPREG_BUF_DESC.html new file mode 100644 index 0000000..1d0e2da --- /dev/null +++ b/docs/dist/html/upnp/UPNPREG_BUF_DESC.html @@ -0,0 +1,21 @@ + + + + + UPNPREG_BUF_DESC + + + + +

UPNPREG_BUF_DESC

The description is a pointer to a character array containing the XML description document.
+ + +
+

Documentation

+
The description is a pointer to a character array containing +the XML description document.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNPREG_FILENAME_DESC.html b/docs/dist/html/upnp/UPNPREG_FILENAME_DESC.html new file mode 100644 index 0000000..175833c --- /dev/null +++ b/docs/dist/html/upnp/UPNPREG_FILENAME_DESC.html @@ -0,0 +1,21 @@ + + + + + UPNPREG_FILENAME_DESC + + + + +

UPNPREG_FILENAME_DESC

The description is a file name on the local file system containing the description of the device.
+ + +
+

Documentation

+
The description is a file name on the local file system +containing the description of the device.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNPREG_URL_DESC.html b/docs/dist/html/upnp/UPNPREG_URL_DESC.html new file mode 100644 index 0000000..4a57ec4 --- /dev/null +++ b/docs/dist/html/upnp/UPNPREG_URL_DESC.html @@ -0,0 +1,20 @@ + + + + + UPNPREG_URL_DESC + + + + +

UPNPREG_URL_DESC

The description is the URL to the description document.
+ + +
+

Documentation

+
The description is the URL to the description document.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_CONTROL_ACTION_COMPLETE.html b/docs/dist/html/upnp/UPNP_CONTROL_ACTION_COMPLETE.html new file mode 100644 index 0000000..4e3c7ad --- /dev/null +++ b/docs/dist/html/upnp/UPNP_CONTROL_ACTION_COMPLETE.html @@ -0,0 +1,22 @@ + + + + + UPNP_CONTROL_ACTION_COMPLETE + + + + +

UPNP_CONTROL_ACTION_COMPLETE

A UpnpSendActionAsync call completed.
+ + +
+

Documentation

+
A UpnpSendActionAsync call completed. The Event +parameter contains a pointer to a Upnp_Action_Complete structure +with the results of the action.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_CONTROL_ACTION_REQUEST.html b/docs/dist/html/upnp/UPNP_CONTROL_ACTION_REQUEST.html new file mode 100644 index 0000000..ee4fbc5 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_CONTROL_ACTION_REQUEST.html @@ -0,0 +1,23 @@ + + + + + UPNP_CONTROL_ACTION_REQUEST + + + + +

UPNP_CONTROL_ACTION_REQUEST

Received by a device when a control point issues a control request.
+ + +
+

Documentation

+
Received by a device when a control point issues a control +request. The Event parameter contains a pointer to a +Upnp_Action_Request structure containing the action. The application +stores the results of the action in this structure.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_CONTROL_GET_VAR_COMPLETE.html b/docs/dist/html/upnp/UPNP_CONTROL_GET_VAR_COMPLETE.html new file mode 100644 index 0000000..b60ac4f --- /dev/null +++ b/docs/dist/html/upnp/UPNP_CONTROL_GET_VAR_COMPLETE.html @@ -0,0 +1,22 @@ + + + + + UPNP_CONTROL_GET_VAR_COMPLETE + + + + +

UPNP_CONTROL_GET_VAR_COMPLETE

A UpnpGetServiceVarStatus call completed.
+ + +
+

Documentation

+
A UpnpGetServiceVarStatus call completed. The Event +parameter contains a pointer to a Upnp_State_Var_Complete structure +containing the value for the variable.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_CONTROL_GET_VAR_REQUEST.html b/docs/dist/html/upnp/UPNP_CONTROL_GET_VAR_REQUEST.html new file mode 100644 index 0000000..37077d4 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_CONTROL_GET_VAR_REQUEST.html @@ -0,0 +1,23 @@ + + + + + UPNP_CONTROL_GET_VAR_REQUEST + + + + +

UPNP_CONTROL_GET_VAR_REQUEST

Received by a device when a query for a single service variable arrives.
+ + +
+

Documentation

+
Received by a device when a query for a single service variable +arrives. The Event parameter contains a pointer to a +Upnp_State_Var_Request structure containing the name of the variable +and value.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_DISCOVERY_ADVERTISEMENT_ALIVE.html b/docs/dist/html/upnp/UPNP_DISCOVERY_ADVERTISEMENT_ALIVE.html new file mode 100644 index 0000000..4d0ba24 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_DISCOVERY_ADVERTISEMENT_ALIVE.html @@ -0,0 +1,23 @@ + + + + + UPNP_DISCOVERY_ADVERTISEMENT_ALIVE + + + + +

UPNP_DISCOVERY_ADVERTISEMENT_ALIVE

Received by a control point when a new device or service is available.
+ + +
+

Documentation

+
Received by a control point when a new device or service is available. +The Event parameter contains a pointer to a +Upnp_Discovery structure with the information about the device +or service.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_DISCOVERY_ADVERTISEMENT_BYEBYE.html b/docs/dist/html/upnp/UPNP_DISCOVERY_ADVERTISEMENT_BYEBYE.html new file mode 100644 index 0000000..67f206e --- /dev/null +++ b/docs/dist/html/upnp/UPNP_DISCOVERY_ADVERTISEMENT_BYEBYE.html @@ -0,0 +1,23 @@ + + + + + UPNP_DISCOVERY_ADVERTISEMENT_BYEBYE + + + + +

UPNP_DISCOVERY_ADVERTISEMENT_BYEBYE

Received by a control point when a device or service shuts down.
+ + +
+

Documentation

+
Received by a control point when a device or service shuts down. The +Event parameter contains a pointer to a Upnp_Discovery +structure containing the information about the device or +service.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_DISCOVERY_SEARCH_RESULT.html b/docs/dist/html/upnp/UPNP_DISCOVERY_SEARCH_RESULT.html new file mode 100644 index 0000000..8b96980 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_DISCOVERY_SEARCH_RESULT.html @@ -0,0 +1,23 @@ + + + + + UPNP_DISCOVERY_SEARCH_RESULT + + + + +

UPNP_DISCOVERY_SEARCH_RESULT

Received by a control point when a matching device or service responds.
+ + +
+

Documentation

+
Received by a control point when a matching device or service responds. +The Event parameter contains a pointer to a +Upnp_Discovery structure containing the information about +the reply to the search request.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_DISCOVERY_SEARCH_TIMEOUT.html b/docs/dist/html/upnp/UPNP_DISCOVERY_SEARCH_TIMEOUT.html new file mode 100644 index 0000000..6cd4b1e --- /dev/null +++ b/docs/dist/html/upnp/UPNP_DISCOVERY_SEARCH_TIMEOUT.html @@ -0,0 +1,22 @@ + + + + + UPNP_DISCOVERY_SEARCH_TIMEOUT + + + + +

UPNP_DISCOVERY_SEARCH_TIMEOUT

Received by a control point when the search timeout expires.
+ + +
+

Documentation

+
Received by a control point when the search timeout expires. The +SDK generates no more callbacks for this search after this +event. The Event parameter is NULL.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_EVENT_AUTORENEWAL_FAILED.html b/docs/dist/html/upnp/UPNP_EVENT_AUTORENEWAL_FAILED.html new file mode 100644 index 0000000..31ca6d8 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_EVENT_AUTORENEWAL_FAILED.html @@ -0,0 +1,23 @@ + + + + + UPNP_EVENT_AUTORENEWAL_FAILED + + + + +

UPNP_EVENT_AUTORENEWAL_FAILED

The auto-renewal of a client subscription failed.
+ + +
+

Documentation

+
The auto-renewal of a client subscription failed. +The Event parameter is a Upnp_Event_Subscribe structure +with the error code set appropriately. The subscription is no longer +valid.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_EVENT_RECEIVED.html b/docs/dist/html/upnp/UPNP_EVENT_RECEIVED.html new file mode 100644 index 0000000..ebf234a --- /dev/null +++ b/docs/dist/html/upnp/UPNP_EVENT_RECEIVED.html @@ -0,0 +1,22 @@ + + + + + UPNP_EVENT_RECEIVED + + + + +

UPNP_EVENT_RECEIVED

Received by a control point when an event arrives.
+ + +
+

Documentation

+
Received by a control point when an event arrives. The +Event parameter contains a Upnp_Event structure +with the information about the event.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_EVENT_RENEWAL_COMPLETE.html b/docs/dist/html/upnp/UPNP_EVENT_RENEWAL_COMPLETE.html new file mode 100644 index 0000000..9c23470 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_EVENT_RENEWAL_COMPLETE.html @@ -0,0 +1,22 @@ + + + + + UPNP_EVENT_RENEWAL_COMPLETE + + + + +

UPNP_EVENT_RENEWAL_COMPLETE

A UpnpRenewSubscriptionAsync call completed.
+ + +
+

Documentation

+
A UpnpRenewSubscriptionAsync call completed. The status of +the renewal is in the Event parameter as a +Upnp_Event_Subscription structure.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_EVENT_SUBSCRIBE_COMPLETE.html b/docs/dist/html/upnp/UPNP_EVENT_SUBSCRIBE_COMPLETE.html new file mode 100644 index 0000000..1bf0cb0 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_EVENT_SUBSCRIBE_COMPLETE.html @@ -0,0 +1,22 @@ + + + + + UPNP_EVENT_SUBSCRIBE_COMPLETE + + + + +

UPNP_EVENT_SUBSCRIBE_COMPLETE

A UpnpSubscribeAsync call completed.
+ + +
+

Documentation

+
A UpnpSubscribeAsync call completed. The status of the +subscription is in the Event parameter as a +Upnp_Event_Subscription structure.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_EVENT_SUBSCRIPTION_EXPIRED.html b/docs/dist/html/upnp/UPNP_EVENT_SUBSCRIPTION_EXPIRED.html new file mode 100644 index 0000000..ae478d1 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_EVENT_SUBSCRIPTION_EXPIRED.html @@ -0,0 +1,23 @@ + + + + + UPNP_EVENT_SUBSCRIPTION_EXPIRED + + + + +

UPNP_EVENT_SUBSCRIPTION_EXPIRED

A client subscription has expired.
+ + +
+

Documentation

+
A client subscription has expired. This will only occur +if auto-renewal of subscriptions is disabled. +The Event parameter is a Upnp_Event_Subscribe +structure. The subscription is no longer valid.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_EVENT_SUBSCRIPTION_REQUEST.html b/docs/dist/html/upnp/UPNP_EVENT_SUBSCRIPTION_REQUEST.html new file mode 100644 index 0000000..07dfc3c --- /dev/null +++ b/docs/dist/html/upnp/UPNP_EVENT_SUBSCRIPTION_REQUEST.html @@ -0,0 +1,27 @@ + + + + + UPNP_EVENT_SUBSCRIPTION_REQUEST + + + + +

UPNP_EVENT_SUBSCRIPTION_REQUEST

Received by a device when a subscription arrives.
+ + +
+

Documentation

+
Received by a device when a subscription arrives. +The Event parameter contains a pointer to a +Upnp_Subscription_Request structure. At this point, the +subscription has already been accepted. UpnpAcceptSubscription +needs to be called to confirm the subscription and transmit the +initial state table. This can be done during this callback. The SDK +generates no events for a subscription unless the device +application calls UpnpAcceptSubscription.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_EVENT_UNSUBSCRIBE_COMPLETE.html b/docs/dist/html/upnp/UPNP_EVENT_UNSUBSCRIBE_COMPLETE.html new file mode 100644 index 0000000..43f8105 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_EVENT_UNSUBSCRIBE_COMPLETE.html @@ -0,0 +1,22 @@ + + + + + UPNP_EVENT_UNSUBSCRIBE_COMPLETE + + + + +

UPNP_EVENT_UNSUBSCRIBE_COMPLETE

A UpnpUnSubscribeAsync call completed.
+ + +
+

Documentation

+
A UpnpUnSubscribeAsync call completed. The status of the +subscription is in the Event parameter as a +Upnp_Event_Subscribe structure.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_ALREADY_REGISTERED-120.html b/docs/dist/html/upnp/UPNP_E_ALREADY_REGISTERED-120.html new file mode 100644 index 0000000..e5dd5a6 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_ALREADY_REGISTERED-120.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_ALREADY_REGISTERED [-120] + + + + +

UPNP_E_ALREADY_REGISTERED [-120]

+
UPNP_E_ALREADY_REGISTERED signifies that a client or a device is +already registered. The SDK currently has a limit of one registered +client and one registered device per process.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_BAD_HTTPMSG-119.html b/docs/dist/html/upnp/UPNP_E_BAD_HTTPMSG-119.html new file mode 100644 index 0000000..c7f8b0c --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_BAD_HTTPMSG-119.html @@ -0,0 +1,21 @@ + + + + + UPNP_E_BAD_HTTPMSG [-119] + + + + +

UPNP_E_BAD_HTTPMSG [-119]

+
UPNP_E_BAD_HTTPMSG signifies that the HTTP message contains invalid +message headers. The error always refers to the HTTP message header +received from the remote host. The main areas where this occurs are in +SOAP control messages (e.g. UpnpSendAction), GENA subscription +message (e.g. UpnpSubscribe), GENA event notifications (e.g. +UpnpNotify), and HTTP transfers (e.g. UpnpDownloadXmlDoc).
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_BAD_RESPONSE-113.html b/docs/dist/html/upnp/UPNP_E_BAD_RESPONSE-113.html new file mode 100644 index 0000000..456bf48 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_BAD_RESPONSE-113.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_BAD_RESPONSE [-113] + + + + +

UPNP_E_BAD_RESPONSE [-113]

+
UPNP_E_BAD_RESPONSE signifies that the response received from the +remote side of a connection is not correct for the protocol. This applies +to the GENA, SOAP, and HTTP protocols.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_CANCELED-210.html b/docs/dist/html/upnp/UPNP_E_CANCELED-210.html new file mode 100644 index 0000000..41b9e39 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_CANCELED-210.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_CANCELED [-210] + + + + +

UPNP_E_CANCELED [-210]

+
UPNP_E_CANCELED signifies that the operation was canceled. This +error can be returned by any function that allows for external +cancelation.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_EXT_NOT_XML-504.html b/docs/dist/html/upnp/UPNP_E_EXT_NOT_XML-504.html new file mode 100644 index 0000000..c5e1283 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_EXT_NOT_XML-504.html @@ -0,0 +1,17 @@ + + + + + UPNP_E_EXT_NOT_XML [-504] + + + + +

UPNP_E_EXT_NOT_XML [-504]

+
UPNP_E_EXT_NOT_XML signifies that the file name of the description +document passed to UpnpRegisterRootDevice2 does not end in ".xml".
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_FILE_NOT_FOUND-502.html b/docs/dist/html/upnp/UPNP_E_FILE_NOT_FOUND-502.html new file mode 100644 index 0000000..5423aca --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_FILE_NOT_FOUND-502.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_FILE_NOT_FOUND [-502] + + + + +

UPNP_E_FILE_NOT_FOUND [-502]

+
UPNP_E_FILE_NOT_FOUND signifies that the filename passed +to one of the device registration functions was not found or was not +accessible.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_FILE_READ_ERROR-503.html b/docs/dist/html/upnp/UPNP_E_FILE_READ_ERROR-503.html new file mode 100644 index 0000000..7c8121a --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_FILE_READ_ERROR-503.html @@ -0,0 +1,16 @@ + + + + + UPNP_E_FILE_READ_ERROR [-503] + + + + +

UPNP_E_FILE_READ_ERROR [-503]

+
UPNP_E_FILE_READ_ERROR signifies an error when reading a file.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_FINISH-116.html b/docs/dist/html/upnp/UPNP_E_FINISH-116.html new file mode 100644 index 0000000..04143b5 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_FINISH-116.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_FINISH [-116] + + + + +

UPNP_E_FINISH [-116]

+
UPNP_E_FINISH signifies that UpnpInit has not been called, or +that UpnpFinish has already been called. None of the API functions +operate until UpnpInit successfully completes.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_INIT-105.html b/docs/dist/html/upnp/UPNP_E_INIT-105.html new file mode 100644 index 0000000..23361f5 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_INIT-105.html @@ -0,0 +1,19 @@ + + + + + UPNP_E_INIT [-105] + + + + +

UPNP_E_INIT [-105]

+
UPNP_E_INIT signifies that the SDK has already been +initialized. The SDK needs to be initialied only once per process. +Any additional initialization attempts simply return this error with +no other ill effects.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_INIT_FAILED-117.html b/docs/dist/html/upnp/UPNP_E_INIT_FAILED-117.html new file mode 100644 index 0000000..3187765 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_INIT_FAILED-117.html @@ -0,0 +1,17 @@ + + + + + UPNP_E_INIT_FAILED [-117] + + + + +

UPNP_E_INIT_FAILED [-117]

+
UPNP_E_INIT_FAILED signifies that UpnpInit cannot complete. +The typical reason is failure to allocate sufficient resources.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_INTERNAL_ERROR-911.html b/docs/dist/html/upnp/UPNP_E_INTERNAL_ERROR-911.html new file mode 100644 index 0000000..b736bc5 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_INTERNAL_ERROR-911.html @@ -0,0 +1,17 @@ + + + + + UPNP_E_INTERNAL_ERROR [-911] + + + + +

UPNP_E_INTERNAL_ERROR [-911]

+
UPNP_E_INTERNAL_ERROR is the generic error code for internal +conditions not covered by other error codes.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_INVALID_ACTION-115.html b/docs/dist/html/upnp/UPNP_E_INVALID_ACTION-115.html new file mode 100644 index 0000000..b7eb10c --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_INVALID_ACTION-115.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_INVALID_ACTION [-115] + + + + +

UPNP_E_INVALID_ACTION [-115]

+
UPNP_E_INVALID_ACTION signifies that the SOAP action message is +invalid. This can be because the DOM document passed to the function was +malformed or the action message is not correct for the given action.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_INVALID_ARGUMENT-501.html b/docs/dist/html/upnp/UPNP_E_INVALID_ARGUMENT-501.html new file mode 100644 index 0000000..8f4d523 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_INVALID_ARGUMENT-501.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_INVALID_ARGUMENT [-501] + + + + +

UPNP_E_INVALID_ARGUMENT [-501]

+
UPNP_E_INVALID_ARGUMENT signifies that one or more of the parameters +passed to a function is invalid. Refer to the individual function +descriptions for the acceptable ranges for parameters.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_INVALID_DESC-107.html b/docs/dist/html/upnp/UPNP_E_INVALID_DESC-107.html new file mode 100644 index 0000000..f7afc6a --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_INVALID_DESC-107.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_INVALID_DESC [-107] + + + + +

UPNP_E_INVALID_DESC [-107]

+
UPNP_E_INVALID_DESC signifies that the description document passed +to UpnpRegisterRootDevice or UpnpRegisterRootDevice2 is an +invalid description document.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_INVALID_HANDLE-100.html b/docs/dist/html/upnp/UPNP_E_INVALID_HANDLE-100.html new file mode 100644 index 0000000..a5c866e --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_INVALID_HANDLE-100.html @@ -0,0 +1,17 @@ + + + + + UPNP_E_INVALID_HANDLE [-100] + + + + +

UPNP_E_INVALID_HANDLE [-100]

+
UPNP_E_INVALID_HANDLE signifies that the handle passed to a +function is not a recognized as a valid handle.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_INVALID_PARAM-101.html b/docs/dist/html/upnp/UPNP_E_INVALID_PARAM-101.html new file mode 100644 index 0000000..8a4e69b --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_INVALID_PARAM-101.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_INVALID_PARAM [-101] + + + + +

UPNP_E_INVALID_PARAM [-101]

+
UPNP_E_INVALID_PARAM signifies that one or more of the parameters +passed to the function is not valid. Refer to the documentation for each +function for more information on the valid ranges of the parameters.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_INVALID_SERVICE-111.html b/docs/dist/html/upnp/UPNP_E_INVALID_SERVICE-111.html new file mode 100644 index 0000000..d0e8532 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_INVALID_SERVICE-111.html @@ -0,0 +1,19 @@ + + + + + UPNP_E_INVALID_SERVICE [-111] + + + + +

UPNP_E_INVALID_SERVICE [-111]

+
UPNP_E_INVALID_SERVICE is returned only by UpnpNotify, +UpnpNotifyExt, UpnpAcceptSubscription, and +UpnpAcceptSubscriptionExt to signify that the device ID/service +ID pair does not refer to a valid service.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_INVALID_URL-108.html b/docs/dist/html/upnp/UPNP_E_INVALID_URL-108.html new file mode 100644 index 0000000..35a4ead --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_INVALID_URL-108.html @@ -0,0 +1,19 @@ + + + + + UPNP_E_INVALID_URL [-108] + + + + +

UPNP_E_INVALID_URL [-108]

+
UPNP_E_INVALID_URL signifies that a URL passed into the function +is invalid. The actual cause is function specific, but in general, the +URL itself might be malformed (e.g. have invalid characters in it) or +the host might be unreachable.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_LISTEN-206.html b/docs/dist/html/upnp/UPNP_E_LISTEN-206.html new file mode 100644 index 0000000..e1ac8d7 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_LISTEN-206.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_LISTEN [-206] + + + + +

UPNP_E_LISTEN [-206]

+
UPNP_E_LISTEN signifies that the SDK had a problem setting the +socket to listen for incoming connections. This error only happens during +initialization (i.e. UpnpInit).
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_NETWORK_ERROR-200.html b/docs/dist/html/upnp/UPNP_E_NETWORK_ERROR-200.html new file mode 100644 index 0000000..d6df42a --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_NETWORK_ERROR-200.html @@ -0,0 +1,20 @@ + + + + + UPNP_E_NETWORK_ERROR [-200] + + + + +

UPNP_E_NETWORK_ERROR [-200]

+
UPNP_E_NETWORK_ERROR signifies that a network error occurred. It +is the generic error code for network problems that are not covered under +one of the more specific error codes. The typical meaning is the SDK +failed to read the local IP address or had problems configuring one of +the sockets.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_NOTIFY_UNACCEPTED-303.html b/docs/dist/html/upnp/UPNP_E_NOTIFY_UNACCEPTED-303.html new file mode 100644 index 0000000..f3a1af8 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_NOTIFY_UNACCEPTED-303.html @@ -0,0 +1,17 @@ + + + + + UPNP_E_NOTIFY_UNACCEPTED [-303] + + + + +

UPNP_E_NOTIFY_UNACCEPTED [-303]

+
UPNP_E_NOTIFY_UNACCEPTED signifies that the remote host did not +accept the notify sent from the local device.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_NOT_FOUND-507.html b/docs/dist/html/upnp/UPNP_E_NOT_FOUND-507.html new file mode 100644 index 0000000..eeac2b2 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_NOT_FOUND-507.html @@ -0,0 +1,17 @@ + + + + + UPNP_E_NOT_FOUND [-507] + + + + +

UPNP_E_NOT_FOUND [-507]

+
UPNP_E_NOT_FOUND signifies that the response to a SOAP request +did not contain the required XML constructs.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_OUTOF_HANDLE-102.html b/docs/dist/html/upnp/UPNP_E_OUTOF_HANDLE-102.html new file mode 100644 index 0000000..98b4526 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_OUTOF_HANDLE-102.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_OUTOF_HANDLE [-102] + + + + +

UPNP_E_OUTOF_HANDLE [-102]

+
UPNP_E_OUTOF_HANDLE signifies that the SDK does not have any +more space for additional handles. The SDK allocates space for only +a few handles in order to conserve memory.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_OUTOF_MEMORY-104.html b/docs/dist/html/upnp/UPNP_E_OUTOF_MEMORY-104.html new file mode 100644 index 0000000..a8db205 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_OUTOF_MEMORY-104.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_OUTOF_MEMORY [-104] + + + + +

UPNP_E_OUTOF_MEMORY [-104]

+
UPNP_E_OUTOF_MEMORY signifies that not enough resources are +currently available to complete the operation. Most operations require +some free memory in order to complete their work.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_OUTOF_SOCKET-205.html b/docs/dist/html/upnp/UPNP_E_OUTOF_SOCKET-205.html new file mode 100644 index 0000000..3573118 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_OUTOF_SOCKET-205.html @@ -0,0 +1,21 @@ + + + + + UPNP_E_OUTOF_SOCKET [-205] + + + + +

UPNP_E_OUTOF_SOCKET [-205]

+
UPNP_E_OUTOF_SOCKET signifies that the SDK cannot create any +more sockets. This occurs in any function that makes +network connections, such as discovery (e.g. UpnpSearchAsync or +UpnpSendAdvertisement), control (e.g. UpnpSendAction), eventing +(e.g. UpnpNotify), and HTTP functions (e.g. +UpnpDownloadXmlDoc).
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_SOCKET_BIND-203.html b/docs/dist/html/upnp/UPNP_E_SOCKET_BIND-203.html new file mode 100644 index 0000000..606ac85 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_SOCKET_BIND-203.html @@ -0,0 +1,21 @@ + + + + + UPNP_E_SOCKET_BIND [-203] + + + + +

UPNP_E_SOCKET_BIND [-203]

+
UPNP_E_SOCKET_BIND signifies that the SDK had a problem binding +a socket to a network interface. This occurs in any function that makes +network connections, such as discovery (e.g. UpnpSearchAsync or +UpnpSendAdvertisement), control (e.g. UpnpSendAction), eventing +(e.g. UpnpNotify), and HTTP functions (e.g. +UpnpDownloadXmlDoc).
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_SOCKET_CONNECT-204.html b/docs/dist/html/upnp/UPNP_E_SOCKET_CONNECT-204.html new file mode 100644 index 0000000..a41b478 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_SOCKET_CONNECT-204.html @@ -0,0 +1,21 @@ + + + + + UPNP_E_SOCKET_CONNECT [-204] + + + + +

UPNP_E_SOCKET_CONNECT [-204]

+
UPNP_E_SOCKET_CONNECT signifies that the SDK had a problem +connecting to a remote host. This occurs in any function that makes +network connections, such as discovery (e.g. UpnpSearchAsync or +UpnpSendAdvertisement), control (e.g. UpnpSendAction), eventing +(e.g. UpnpNotify), and HTTP functions (e.g. +UpnpDownloadXmlDoc).
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_SOCKET_ERROR-208.html b/docs/dist/html/upnp/UPNP_E_SOCKET_ERROR-208.html new file mode 100644 index 0000000..6164934 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_SOCKET_ERROR-208.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_SOCKET_ERROR [-208] + + + + +

UPNP_E_SOCKET_ERROR [-208]

+
UPNP_E_SOCKET_ERROR is the generic socket error code for +conditions not covered by other error codes. This error can be returned +by any function that performs network operations.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_SOCKET_READ-202.html b/docs/dist/html/upnp/UPNP_E_SOCKET_READ-202.html new file mode 100644 index 0000000..7731ac9 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_SOCKET_READ-202.html @@ -0,0 +1,20 @@ + + + + + UPNP_E_SOCKET_READ [-202] + + + + +

UPNP_E_SOCKET_READ [-202]

+
UPNP_E_SOCKET_READ signifies an error reading from a socket. This +occurs in any function that makes network connections, such +as discovery (e.g. UpnpSearchAsync or UpnpSendAdvertisement), +control (e.g. UpnpSendAction), eventing (e.g. UpnpNotify), +and HTTP functions (e.g. UpnpDownloadXmlDoc).
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_SOCKET_WRITE-201.html b/docs/dist/html/upnp/UPNP_E_SOCKET_WRITE-201.html new file mode 100644 index 0000000..d59c1b4 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_SOCKET_WRITE-201.html @@ -0,0 +1,20 @@ + + + + + UPNP_E_SOCKET_WRITE [-201] + + + + +

UPNP_E_SOCKET_WRITE [-201]

+
UPNP_E_SOCKET_WRITE signifies an error writing to a socket. This +occurs in any function that makes network connections, such +as discovery (e.g. UpnpSearchAsync or UpnpSendAdvertisement), +control (e.g. UpnpSendAction), eventing (e.g. UpnpNotify), +and HTTP functions (e.g. UpnpDownloadXmlDoc).
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_SUBSCRIBE_UNACCEPTED-301.html b/docs/dist/html/upnp/UPNP_E_SUBSCRIBE_UNACCEPTED-301.html new file mode 100644 index 0000000..e3ccf22 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_SUBSCRIBE_UNACCEPTED-301.html @@ -0,0 +1,17 @@ + + + + + UPNP_E_SUBSCRIBE_UNACCEPTED [-301] + + + + +

UPNP_E_SUBSCRIBE_UNACCEPTED [-301]

+
UPNP_E_SUBSCRIBE_UNACCEPTED signifies that a subscription +request was rejected from the remote side.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_SUCCESS0.html b/docs/dist/html/upnp/UPNP_E_SUCCESS0.html new file mode 100644 index 0000000..4e3bab9 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_SUCCESS0.html @@ -0,0 +1,19 @@ + + + + + UPNP_E_SUCCESS [0] + + + + +

UPNP_E_SUCCESS [0]

+
UPNP_E_SUCCESS signifies that the operation completed successfully. +For asynchronous functions, this only means that the packet generated by +the operation was successfully transmitted on the network. The result of +the entire operation comes as part of the callback for that operation.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_TIMEDOUT-207.html b/docs/dist/html/upnp/UPNP_E_TIMEDOUT-207.html new file mode 100644 index 0000000..9c00d25 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_TIMEDOUT-207.html @@ -0,0 +1,18 @@ + + + + + UPNP_E_TIMEDOUT [-207] + + + + +

UPNP_E_TIMEDOUT [-207]

+
UPNP_E_TIMEDOUT signifies that too much time elapsed before the +required number of bytes were sent or received over a socket. This error +can be returned by any function that performs network operations.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_E_UNSUBSCRIBE_UNACCAPTED-302.html b/docs/dist/html/upnp/UPNP_E_UNSUBSCRIBE_UNACCAPTED-302.html new file mode 100644 index 0000000..f637757 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_E_UNSUBSCRIBE_UNACCAPTED-302.html @@ -0,0 +1,17 @@ + + + + + UPNP_E_UNSUBSCRIBE_UNACCAPTED [-302] + + + + +

UPNP_E_UNSUBSCRIBE_UNACCAPTED [-302]

+
UPNP_E_UNSUBSCRIBE_UNACCEPTED signifies that an unsubscribe +request was rejected from the remote side.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_S_ALL.html b/docs/dist/html/upnp/UPNP_S_ALL.html new file mode 100644 index 0000000..4432d50 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_S_ALL.html @@ -0,0 +1,20 @@ + + + + + UPNP_S_ALL + + + + +

UPNP_S_ALL

Search for all devices and services on the network.
+ + +
+

Documentation

+
Search for all devices and services on the network.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_S_DEVICE.html b/docs/dist/html/upnp/UPNP_S_DEVICE.html new file mode 100644 index 0000000..bbcdc55 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_S_DEVICE.html @@ -0,0 +1,21 @@ + + + + + UPNP_S_DEVICE + + + + +

UPNP_S_DEVICE

Search for a particular device type or a particular device instance.
+ + +
+

Documentation

+
Search for a particular device type or a particular device +instance.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_S_ROOT.html b/docs/dist/html/upnp/UPNP_S_ROOT.html new file mode 100644 index 0000000..d090533 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_S_ROOT.html @@ -0,0 +1,20 @@ + + + + + UPNP_S_ROOT + + + + +

UPNP_S_ROOT

Search for all root devices on the network.
+ + +
+

Documentation

+
Search for all root devices on the network.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPNP_S_SERVICE.html b/docs/dist/html/upnp/UPNP_S_SERVICE.html new file mode 100644 index 0000000..4f3b7b8 --- /dev/null +++ b/docs/dist/html/upnp/UPNP_S_SERVICE.html @@ -0,0 +1,21 @@ + + + + + UPNP_S_SERVICE + + + + +

UPNP_S_SERVICE

Search for a particular service type, possibly on a particular device type or device instance.
+ + +
+

Documentation

+
Search for a particular service type, possibly on a particular +device type or device instance.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UPnP_EventType.html b/docs/dist/html/upnp/UPnP_EventType.html new file mode 100644 index 0000000..3636a80 --- /dev/null +++ b/docs/dist/html/upnp/UPnP_EventType.html @@ -0,0 +1,83 @@ + + + + + enum UPnP_EventType + + + + +

enum UPnP_EventType

The reason code for an event callback.
+ +
The Event parameter will be different depending on the +reason for the callback. The descriptions for each event +type describe the contents of the Event parameter.
+ +
+
+
+ +o +UPNP_CONTROL_ACTION_REQUEST
Received by a device when a control point issues a control request. +
+ +o +UPNP_CONTROL_ACTION_COMPLETE
A UpnpSendActionAsync call completed. +
+ +o +UPNP_CONTROL_GET_VAR_REQUEST
Received by a device when a query for a single service variable arrives. +
+ +o +UPNP_CONTROL_GET_VAR_COMPLETE
A UpnpGetServiceVarStatus call completed. +
+ +o +UPNP_DISCOVERY_ADVERTISEMENT_ALIVE
Received by a control point when a new device or service is available. +
+ +o +UPNP_DISCOVERY_ADVERTISEMENT_BYEBYE
Received by a control point when a device or service shuts down. +
+ +o +UPNP_DISCOVERY_SEARCH_RESULT
Received by a control point when a matching device or service responds. +
+ +o +UPNP_DISCOVERY_SEARCH_TIMEOUT
Received by a control point when the search timeout expires. +
+ +o +UPNP_EVENT_SUBSCRIPTION_REQUEST
Received by a device when a subscription arrives. +
+ +o +UPNP_EVENT_RECEIVED
Received by a control point when an event arrives. +
+ +o +UPNP_EVENT_RENEWAL_COMPLETE
A UpnpRenewSubscriptionAsync call completed. +
+ +o +UPNP_EVENT_SUBSCRIBE_COMPLETE
A UpnpSubscribeAsync call completed. +
+ +o +UPNP_EVENT_UNSUBSCRIBE_COMPLETE
A UpnpUnSubscribeAsync call completed. +
+ +o +UPNP_EVENT_AUTORENEWAL_FAILED
The auto-renewal of a client subscription failed. +
+ +o +UPNP_EVENT_SUBSCRIPTION_EXPIRED
A client subscription has expired. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpAcceptSubscription.html b/docs/dist/html/upnp/UpnpAcceptSubscription.html new file mode 100644 index 0000000..03a2472 --- /dev/null +++ b/docs/dist/html/upnp/UpnpAcceptSubscription.html @@ -0,0 +1,55 @@ + + + + + EXPORT_SPEC int UpnpAcceptSubscription + + + + +

EXPORT_SPEC int UpnpAcceptSubscription

( IN UpnpDevice_Handle Hnd,
  IN const char* DevID,
  IN const char* ServID,
  IN const char** VarName,
  IN const char** NewVal,
  IN int cVariables,
  IN Upnp_SID SubsId )

UpnpAcceptSubscription accepts a subscription request and sends out the current state of the eventable variables for a service.
+ + +
+

Documentation

+
UpnpAcceptSubscription accepts a subscription request and sends +out the current state of the eventable variables for a service. +The device application should call this function when it receives a +UPNP_EVENT_SUBSCRIPTION_REQUEST callback. This function is +synchronous and generates no callbacks. + +

UpnpAcceptSubscription can be called during the execution of +a callback function. + +

+
Parameters:
Hnd - The handle of the device. +
DevID - The device ID of the subdevice of the +service generating the event. +
ServID - The unique service identifier of the service +generating the event. +
VarName - Pointer to an array of event variables. +
NewVal - Pointer to an array of values for +the event variables. +
cVariables - The number of event variables in +VarName. +
SubsId - The subscription ID of the newly +registered control point.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid device +handle. +
  • UPNP_E_INVALID_SERVICE: The DevId/ServId +pair refers to an invalid service. +
  • UPNP_E_INVALID_SID: The specified subscription ID is not +valid. +
  • UPNP_E_INVALID_PARAM: Either VarName, +NewVal, DevID, or ServID is not a valid +pointer or cVariables is less than zero. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpAcceptSubscriptionExt.html b/docs/dist/html/upnp/UpnpAcceptSubscriptionExt.html new file mode 100644 index 0000000..f44223d --- /dev/null +++ b/docs/dist/html/upnp/UpnpAcceptSubscriptionExt.html @@ -0,0 +1,54 @@ + + + + + EXPORT_SPEC int UpnpAcceptSubscriptionExt + + + + +

EXPORT_SPEC int UpnpAcceptSubscriptionExt

( IN UpnpDevice_Handle Hnd,
  IN const char* DevID,
  IN const char* ServID,
  IN IXML_Document* PropSet,
  IN Upnp_SID SubsId )

UpnpAcceptSubscriptionExt is similar to UpnpAcceptSubscription except that it takes a DOM document for the variables to event rather than an array of strings.
+ + +
+

Documentation

+
UpnpAcceptSubscriptionExt is similar to UpnpAcceptSubscription +except that it takes a DOM document for the variables to event rather +than an array of strings. This function is sychronous +and generates no callbacks. + +

UpnpAcceptSubscriptionExt can be called during the execution of +a callback function. + +

+
Parameters:
Hnd - The handle of the device. +
DevID - The device ID of the subdevice of the +service generating the event. +
ServID - The unique service identifier of the service +generating the event. +
PropSet - The DOM document for the property set. +Property set documents must conform to +the XML schema defined in section 4.3 of the +Universal Plug and Play Device Architecture +specification. +
SubsId - The subscription ID of the newly +registered control point.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid device +handle. +
  • UPNP_E_INVALID_SERVICE: The DevId/ServId +pair refers to an invalid service. +
  • UPNP_E_INVALID_SID: The specified subscription ID is not +valid. +
  • UPNP_E_INVALID_PARAM: Either VarName, +NewVal, DevID, ServID, or PropSet +is not a valid pointer. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpAddToAction.html b/docs/dist/html/upnp/UpnpAddToAction.html new file mode 100644 index 0000000..7d7d8a4 --- /dev/null +++ b/docs/dist/html/upnp/UpnpAddToAction.html @@ -0,0 +1,40 @@ + + + + + EXPORT_SPEC int UpnpAddToAction + + + + +

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 )

UpnpAddToAction creates an action request packet based on its input parameters (status variable name and value pair).
+ + +
+

Documentation

+
UpnpAddToAction creates an action request packet based on its input +parameters (status variable name and value pair). This API is specially +suitable inside a loop to add any number input parameters into an existing +action. If no action document exists in the beginning then a +Upnp_Document variable initialized with NULL should be passed +as a parameter. + +

+
Parameters:
ActionDoc - A pointer to store the action +document node. +
- ActionName The action name. +
ServType - The service type. +
ArgName - The status variable name. +
ArgVal - The status variable value.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: One or more of the parameters +are invalid. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpAddToActionResponse.html b/docs/dist/html/upnp/UpnpAddToActionResponse.html new file mode 100644 index 0000000..8dba961 --- /dev/null +++ b/docs/dist/html/upnp/UpnpAddToActionResponse.html @@ -0,0 +1,42 @@ + + + + + EXPORT_SPEC int UpnpAddToActionResponse + + + + +

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 )

UpnpAddToActionResponse creates an action response packet based on its output parameters (status variable name and value pair).
+ + +
+

Documentation

+
UpnpAddToActionResponse creates an action response +packet based on its output parameters (status variable name +and value pair). This API is especially suitable inside +a loop to add any number of input parameters into an existing action +response. If no action document exists in the beginning, a +Upnp_Document variable initialized with NULL should be passed +as a parameter. + +

+
Parameters:
ActionResponse - Pointer to a document to +store the action document +node. +
- ActionName The action name. +
ServType - The service type. +
ArgName - The status variable name. +
ArgVal - The status variable value.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: One or more of the parameters +are invalid. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpAddToPropertySet.html b/docs/dist/html/upnp/UpnpAddToPropertySet.html new file mode 100644 index 0000000..5169020 --- /dev/null +++ b/docs/dist/html/upnp/UpnpAddToPropertySet.html @@ -0,0 +1,38 @@ + + + + + EXPORT_SPEC int UpnpAddToPropertySet + + + + +

EXPORT_SPEC int UpnpAddToPropertySet

( IN OUT IXML_Document** PropSet,
  IN const char* ArgName,
  IN const char* ArgVal )

UpnpAddToPropertySet can be used when an application needs to transfer the status of many variables at once.
+ + +
+

Documentation

+
UpnpAddToPropertySet can be used when an application needs to +transfer the status of many variables at once. It can be used +(inside a loop) to add some extra status variables into an existing +property set. If the application does not already have a property +set document, the application should create a variable initialized +with NULL and pass that as the first parameter. + +

+
Parameters:
PropSet - A pointer to the document containing +the property set document node. +
ArgName - The status variable name. +
ArgVal - The status variable value.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: One or more of the parameters +are invalid. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpAddVirtualDir.html b/docs/dist/html/upnp/UpnpAddVirtualDir.html new file mode 100644 index 0000000..63a930b --- /dev/null +++ b/docs/dist/html/upnp/UpnpAddVirtualDir.html @@ -0,0 +1,32 @@ + + + + + EXPORT_SPEC int UpnpAddVirtualDir + + + + +

EXPORT_SPEC int UpnpAddVirtualDir

( IN const char* dirName )

UpnpAddVirtualDir adds a virtual directory mapping.
+ + +
+

Documentation

+
UpnpAddVirtualDir adds a virtual directory mapping. + +

All webserver requests containing the given directory are read using +functions contained in a UpnpVirtualDirCallbacks structure registered +via UpnpSetVirtualDirCallbacks. + +

+
Parameters:
dirName - The name of the new directory mapping to add. +
Returns:
[int] An integer representing one of the following: +
    +
  • UPPN_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_ARGUMENT: dirName is not valid. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpCancelHttpGet.html b/docs/dist/html/upnp/UpnpCancelHttpGet.html new file mode 100644 index 0000000..b0fffcc --- /dev/null +++ b/docs/dist/html/upnp/UpnpCancelHttpGet.html @@ -0,0 +1,27 @@ + + + + + EXPORT_SPEC int UpnpCancelHttpGet + + + + +

EXPORT_SPEC int UpnpCancelHttpGet

(IN void* handle)

UpnpCancelHttpGet set the cancel flag of the handle parameter.
+ + +
+

Documentation

+
UpnpCancelHttpGet set the cancel flag of the handle +parameter. + +

+
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: handle is not a valid pointer. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpClient_Handle.html b/docs/dist/html/upnp/UpnpClient_Handle.html new file mode 100644 index 0000000..ff62e99 --- /dev/null +++ b/docs/dist/html/upnp/UpnpClient_Handle.html @@ -0,0 +1,22 @@ + + + + + typedef int UpnpClient_Handle + + + + +

typedef int UpnpClient_Handle

Returned when a control point application registers with UpnpRegisterClient.
+ + +
+

Documentation

+
Returned when a control point application registers with +UpnpRegisterClient. Client handles can only be used with +functions that operate with a client handle.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpCloseHttpGet.html b/docs/dist/html/upnp/UpnpCloseHttpGet.html new file mode 100644 index 0000000..1eb3d1a --- /dev/null +++ b/docs/dist/html/upnp/UpnpCloseHttpGet.html @@ -0,0 +1,27 @@ + + + + + EXPORT_SPEC int UpnpCloseHttpGet + + + + +

EXPORT_SPEC int UpnpCloseHttpGet

(IN void* handle)

UpnpCloseHttpGet closes the connection and frees memory that was allocated for the handle parameter.
+ + +
+

Documentation

+
UpnpCloseHttpGet closes the connection and frees memory that was +allocated for the handle parameter. + +

+
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: handle is not a valid pointer. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpCloseHttpPost.html b/docs/dist/html/upnp/UpnpCloseHttpPost.html new file mode 100644 index 0000000..a116d4c --- /dev/null +++ b/docs/dist/html/upnp/UpnpCloseHttpPost.html @@ -0,0 +1,42 @@ + + + + + EXPORT_SPEC int UpnpCloseHttpPost + + + + +

EXPORT_SPEC int UpnpCloseHttpPost

( IN void* handle,
  IN OUT int* httpStatus,
  IN int timeout )

UpnpCloseHttpPost sends and receives any pending data, closes the connection with the server, and frees memory allocated during the UpnpOpenHttpPost call.
+ + +
+

Documentation

+
UpnpCloseHttpPost sends and receives any pending data, closes the +connection with the server, and frees memory allocated during the +UpnpOpenHttpPost call. + +

+
Parameters:
handle - The handle of the connection to close, +created by the call to +UpnpOpenHttpPost. +
httpStatus - A pointer to a buffer to store the +final status of the connection. +
timeout - A time out value sent with the request +during which a response is expected from +the server, failing which, an error is +reported.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: Either handle, or +httpStatus is not a valid pointer. +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket. +
  • UPNP_E_OUTOF_SOCKET: Too many sockets are currently +allocated. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpCreatePropertySet.html b/docs/dist/html/upnp/UpnpCreatePropertySet.html new file mode 100644 index 0000000..66874a0 --- /dev/null +++ b/docs/dist/html/upnp/UpnpCreatePropertySet.html @@ -0,0 +1,28 @@ + + + + + EXPORT_SPEC IXML_Document* UpnpCreatePropertySet + + + + +

EXPORT_SPEC IXML_Document* UpnpCreatePropertySet

( IN int NumArg,
  IN const char* Arg,
  IN ... )

UpnpCreatePropertySet creates a property set message packet.
+ + +
+

Documentation

+
UpnpCreatePropertySet creates a property set +message packet. Any number of input parameters can be passed +to this function but every input variable name should have +a matching value input argument. + +

+
Parameters:
NumArg - The number of argument pairs passed. +
Arg - The status variable name and value pair.
Returns:
[IXML_Document*] NULL on failure, or the property-set +document node. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpDevice_Handle.html b/docs/dist/html/upnp/UpnpDevice_Handle.html new file mode 100644 index 0000000..91fa4bc --- /dev/null +++ b/docs/dist/html/upnp/UpnpDevice_Handle.html @@ -0,0 +1,22 @@ + + + + + typedef int UpnpDevice_Handle + + + + +

typedef int UpnpDevice_Handle

Returned when a device application registers with UpnpRegisterRootDevice or UpnpRegisterRootDevice2.
+ + +
+

Documentation

+
Returned when a device application registers with +UpnpRegisterRootDevice or UpnpRegisterRootDevice2. Device handles +can only be used with functions that operate with a device handle.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpDownloadUrlItem.html b/docs/dist/html/upnp/UpnpDownloadUrlItem.html new file mode 100644 index 0000000..694f4cc --- /dev/null +++ b/docs/dist/html/upnp/UpnpDownloadUrlItem.html @@ -0,0 +1,50 @@ + + + + + EXPORT_SPEC int UpnpDownloadUrlItem + + + + +

EXPORT_SPEC int UpnpDownloadUrlItem

( IN const char* url,
  OUT char** outBuf,
  OUT char* contentType )

UpnpDownloadUrlItem downloads a file specified in a URL.
+ + +
+

Documentation

+
UpnpDownloadUrlItem downloads a file specified in a URL. +The SDK allocates the memory for outBuf and the +application is responsible for freeing this memory. Note that +the item is passed as a single buffer. Large items should not +be transferred using this function. + +

+
Parameters:
url - URL of an item to download. +
outBuf - Buffer to store the downloaded item. +
contentType - HTTP header value content type if +present. It should be at least +LINE_SIZE bytes in size.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: Either url, outBuf +or contentType is not a valid pointer. +
  • UPNP_E_INVALID_URL: The url is not a valid +URL. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +download this file. +
  • UPNP_E_NETWORK_ERROR: A network error occurred. +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket. +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket. +
  • UPNP_E_SOCKET_BIND: An error occurred binding a socket. +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting a +socket. +
  • UPNP_E_OUTOF_SOCKET: Too many sockets are currently +allocated. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpDownloadXmlDoc.html b/docs/dist/html/upnp/UpnpDownloadXmlDoc.html new file mode 100644 index 0000000..4551568 --- /dev/null +++ b/docs/dist/html/upnp/UpnpDownloadXmlDoc.html @@ -0,0 +1,48 @@ + + + + + EXPORT_SPEC int UpnpDownloadXmlDoc + + + + +

EXPORT_SPEC int UpnpDownloadXmlDoc

( IN const char* url,
  OUT IXML_Document** xmlDoc )

UpnpDownloadXmlDoc downloads an XML document specified in a URL.
+ + +
+

Documentation

+
UpnpDownloadXmlDoc downloads an XML document specified in a URL. +The SDK parses the document and returns it in the form of a +DOM document. The application is responsible for freeing the DOM document. + +

+
Parameters:
url - URL of the XML document. +
xmlDoc - A pointer in which to store the +XML document.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: Either url or xmlDoc +is not a valid pointer. +
  • UPNP_E_INVALID_DESC: The XML document was not +found or it does not contain a valid XML description. +
  • UPNP_E_INVALID_URL: The url is not a valid +URL. +
  • UPNP_E_OUTOF_MEMORY: There are insufficient resources to +download the XML document. +
  • UPNP_E_NETWORK_ERROR: A network error occurred. +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket. +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket. +
  • UPNP_E_SOCKET_BIND: An error occurred binding a socket. +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting the +socket. +
  • UPNP_E_OUTOF_SOCKET: Too many sockets are currently +allocated. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpEnableWebserver.html b/docs/dist/html/upnp/UpnpEnableWebserver.html new file mode 100644 index 0000000..bdb8865 --- /dev/null +++ b/docs/dist/html/upnp/UpnpEnableWebserver.html @@ -0,0 +1,28 @@ + + + + + EXPORT_SPEC int UpnpEnableWebserver + + + + +

EXPORT_SPEC int UpnpEnableWebserver

( IN int enable )

UpnpEnableWebServer enables or disables the webserver.
+ + +
+

Documentation

+
UpnpEnableWebServer enables or disables the webserver. A value of +TRUE enables the webserver, FALSE disables it. + +

+
Parameters:
enable - TRUE to enable, FALSE to disable.
Returns:
[int] An integer representing one of the following: +
    +
  • UPPN_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_ARGUMENT: enable is not valid. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpFinish.html b/docs/dist/html/upnp/UpnpFinish.html new file mode 100644 index 0000000..d8ea0aa --- /dev/null +++ b/docs/dist/html/upnp/UpnpFinish.html @@ -0,0 +1,29 @@ + + + + + EXPORT_SPEC int UpnpFinish + + + + +

EXPORT_SPEC int UpnpFinish

()

Terminates the Linux SDK for UPnP Devices.
+ + +
+

Documentation

+
Terminates the Linux SDK for UPnP Devices. This function must be the last +API function called. It should be called only once. Subsequent calls to +this API return a UPNP_E_FINISH error code. + +

+
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_FINISH: The SDK is already terminated or +it is not initialized. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpGetErrorMessage.html b/docs/dist/html/upnp/UpnpGetErrorMessage.html new file mode 100644 index 0000000..8c0dee6 --- /dev/null +++ b/docs/dist/html/upnp/UpnpGetErrorMessage.html @@ -0,0 +1,26 @@ + + + + + EXPORT_SPEC const char* UpnpGetErrorMessage + + + + +

EXPORT_SPEC const char* UpnpGetErrorMessage

( int errorcode )

UpnpGetErrorMessage converts an SDK error code into a string error message suitable for display.
+ + +
+

Documentation

+
UpnpGetErrorMessage converts an SDK error code into a +string error message suitable for display. The memory returned +from this function should NOT be freed. + +

+
Parameters:
errorcode - The SDK error code to convert.
Returns:
[char*] An ASCII text string representation of the error message +associated with the error code. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpGetServerIpAddress.html b/docs/dist/html/upnp/UpnpGetServerIpAddress.html new file mode 100644 index 0000000..9729361 --- /dev/null +++ b/docs/dist/html/upnp/UpnpGetServerIpAddress.html @@ -0,0 +1,26 @@ + + + + + EXPORT_SPEC char* UpnpGetServerIpAddress + + + + +

EXPORT_SPEC char* UpnpGetServerIpAddress

(void)

If NULL is used as the IP address in UpnpInit, then this function can be used to retrieve the actual interface address on which device is running.
+ + +
+

Documentation

+
If NULL is used as the IP address in UpnpInit, then this +function can be used to retrieve the actual interface address +on which device is running. If UpnpInit has not succeeded +then NULL is returned. + +

+
Returns:
[char*] The IP address on which an internal server is listening +for UPnP related requests.

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpGetServerPort.html b/docs/dist/html/upnp/UpnpGetServerPort.html new file mode 100644 index 0000000..e311b68 --- /dev/null +++ b/docs/dist/html/upnp/UpnpGetServerPort.html @@ -0,0 +1,26 @@ + + + + + EXPORT_SPEC unsigned short UpnpGetServerPort + + + + +

EXPORT_SPEC unsigned short UpnpGetServerPort

(void)

If '0' is used as the port number in UpnpInit, then this function can be used to retrieve the actual port allocated to the SDK.
+ + +
+

Documentation

+
If '0' is used as the port number in UpnpInit, then this +function can be used to retrieve the actual port allocated to +the SDK. If UpnpInit has not succeeded then 0 is +returned. + +

+
Returns:
[unsigned short] The port on which an internal server is +listening for UPnP related requests.

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpGetServiceVarStatus.html b/docs/dist/html/upnp/UpnpGetServiceVarStatus.html new file mode 100644 index 0000000..e7e3427 --- /dev/null +++ b/docs/dist/html/upnp/UpnpGetServiceVarStatus.html @@ -0,0 +1,48 @@ + + + + + EXPORT_SPEC int UpnpGetServiceVarStatus + + + + +

EXPORT_SPEC int UpnpGetServiceVarStatus

( IN UpnpClient_Handle Hnd,
  IN const char* ActionURL,
  IN const char* VarName,
  OUT DOMString* StVarVal )

UpnpGetServiceVarStatus queries the state of a state variable of a service on another device.
+ + +
+

Documentation

+
UpnpGetServiceVarStatus queries the state of a state +variable of a service on another device. This is a synchronous call. +A positive return value indicates a SOAP error code, whereas a negative +return code indicates an SDK error code. Note that the use of this +function is deprecated by the UPnP Forum. + +

+
Parameters:
Hnd - The handle of the control point. +
ActionURL - The URL of the service. +
VarName - The name of the variable to query. +
StVarVal - The pointer to store the value +for VarName. The SDK +allocates this string and the caller +needs to free it using +ixmlFreeDOMString.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_URL: ActionUrl is not a valid URL. +
  • UPNP_E_INVALID_DESC: The XML document was not +found or it does not contain a valid XML description. +
  • UPNP_E_INVALID_PARAM: StVarVal is not a valid +pointer or VarName or ActionUrl is NULL. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
  • UPNP_SOAP_E_INVALID_VAR: The given variable is invalid +according to the device. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpGetServiceVarStatusAsync.html b/docs/dist/html/upnp/UpnpGetServiceVarStatusAsync.html new file mode 100644 index 0000000..4f64f62 --- /dev/null +++ b/docs/dist/html/upnp/UpnpGetServiceVarStatusAsync.html @@ -0,0 +1,41 @@ + + + + + EXPORT_SPEC int UpnpGetServiceVarStatusAsync + + + + +

EXPORT_SPEC int UpnpGetServiceVarStatusAsync

( IN UpnpClient_Handle Hnd,
  IN const char* ActionURL,
  IN const char* VarName,
  IN Upnp_FunPtr Fun,
  IN const void* Cookie )

UpnpGetServiceVarStatusAsync queries the state of a variable of a service, generating a callback when the operation is complete.
+ + +
+

Documentation

+
UpnpGetServiceVarStatusAsync queries the state of a variable of a +service, generating a callback when the operation is complete. Note +that the use of this function is deprecated by the UPnP Forum. + +

+
Parameters:
Hnd - The handle of the control point. +
ActionURL - The URL of the service. +
VarName - The name of the variable to query. +
Fun - Pointer to a callback function to +be invoked when the operation is complete. +
Cookie - Pointer to user data to pass to the +callback function when invoked.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_URL: The ActionUrl is not a valid URL. +
  • UPNP_E_INVALID_PARAM: VarName, Fun or +ActionUrl is not a valid pointer. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpHttpGetProgress.html b/docs/dist/html/upnp/UpnpHttpGetProgress.html new file mode 100644 index 0000000..87aa552 --- /dev/null +++ b/docs/dist/html/upnp/UpnpHttpGetProgress.html @@ -0,0 +1,32 @@ + + + + + EXPORT_SPEC int UpnpHttpGetProgress + + + + +

EXPORT_SPEC int UpnpHttpGetProgress

( IN void* handle,
  OUT unsigned int* length,
  OUT unsigned int* total )

UpnpHttpGetProgress rettrieve progress information of a http-get transfer.
+ + +
+

Documentation

+
UpnpHttpGetProgress rettrieve progress information of a http-get +transfer. + +

+
Parameters:
handle - The token created by the call to +UpnpOpenHttpGet. +
length - The number of bytes received. +
total - The content length.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: Either handle, length +or total is not a valid pointer. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpInit.html b/docs/dist/html/upnp/UpnpInit.html new file mode 100644 index 0000000..2b2ec3a --- /dev/null +++ b/docs/dist/html/upnp/UpnpInit.html @@ -0,0 +1,54 @@ + + + + + EXPORT_SPEC int UpnpInit + + + + +

EXPORT_SPEC int UpnpInit

( IN const char* HostIP,
  IN unsigned short DestPort )

Initializes the Linux SDK for UPnP Devices.
+ + +
+

Documentation

+
Initializes the Linux SDK for UPnP Devices. This function must be called +before any other API function can be called. It should be called +only once. Subsequent calls to this API return a UPNP_E_INIT +error code. + +

Optionally, the application can specify a host IP address (in the +case of a multi-homed configuration) and a port number to use for +all UPnP operations. Since a port number can be used only by one +process, multiple processes using the SDK must specify +different port numbers. + +

If unspecified, the SDK will use the first adapter's IP address +and an arbitrary port. + +

This call is synchronous. + +

+
Parameters:
HostIP - The host IP address to use, in +string format, for example "192.168.0.1", +or NULL to use the first adapter's +IP address. +
DestPort - The destination port number to use. 0 +will pick an arbitrary free port.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist +to initialize the SDK. +
  • UPNP_E_INIT: The SDK is already initialized. +
  • UPNP_E_INIT_FAILED: The SDK initialization +failed for an unknown reason. +
  • UPNP_E_SOCKET_BIND: An error occurred binding a socket. +
  • UPNP_E_LISTEN: An error occurred listening to a socket. +
  • UPNP_E_OUTOF_SOCKET: An error ocurred creating a socket. +
  • UPNP_E_INTERNAL_ERROR: An internal error ocurred. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpIsWebserverEnabled.html b/docs/dist/html/upnp/UpnpIsWebserverEnabled.html new file mode 100644 index 0000000..ed10b06 --- /dev/null +++ b/docs/dist/html/upnp/UpnpIsWebserverEnabled.html @@ -0,0 +1,27 @@ + + + + + EXPORT_SPEC int UpnpIsWebserverEnabled + + + + +

EXPORT_SPEC int UpnpIsWebserverEnabled

()

UpnpIsWebServerEnabled returns TRUE if the webserver is enabled, or FALSE if it is not.
+ + +
+

Documentation

+
UpnpIsWebServerEnabled returns TRUE if the webserver is +enabled, or FALSE if it is not. + +

+
Returns:
[int] An integer representing one of the following: +
    +
  • TRUE: The webserver is enabled. +
  • FALSE: The webserver is not enabled +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpMakeAction.html b/docs/dist/html/upnp/UpnpMakeAction.html new file mode 100644 index 0000000..83db62a --- /dev/null +++ b/docs/dist/html/upnp/UpnpMakeAction.html @@ -0,0 +1,30 @@ + + + + + EXPORT_SPEC IXML_Document* UpnpMakeAction + + + + +

EXPORT_SPEC IXML_Document* UpnpMakeAction

( IN const char* ActionName,
  IN const char* ServType,
  IN int NumArg,
  IN const char* Arg,
  IN ... )

UpnpMakeAction creates an action request packet based on its input parameters (status variable name and value pair).
+ + +
+

Documentation

+
UpnpMakeAction creates an action request packet based on its input +parameters (status variable name and value pair). Any number of input +parameters can be passed to this function but every input variable name +should have a matching value argument. + +

+
Parameters:
- ActionName The action name. +
ServType - The service type. +
NumArg - Number of argument pairs to be passed. +
Arg - Status variable name and value pair.
Returns:
[IXML_Document*] The action node of Upnp_Document type or +NULL if the operation failed. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpMakeActionResponse.html b/docs/dist/html/upnp/UpnpMakeActionResponse.html new file mode 100644 index 0000000..c4fa868 --- /dev/null +++ b/docs/dist/html/upnp/UpnpMakeActionResponse.html @@ -0,0 +1,30 @@ + + + + + EXPORT_SPEC IXML_Document* UpnpMakeActionResponse + + + + +

EXPORT_SPEC IXML_Document* UpnpMakeActionResponse

( IN const char* ActionName,
  IN const char* ServType,
  IN int NumArg,
  IN const char* Arg,
  IN ... )

UpnpMakeActionResponse creates an action response packet based on its output parameters (status variable name and value pair).
+ + +
+

Documentation

+
UpnpMakeActionResponse creates an action response packet based +on its output parameters (status variable name and value pair). Any +number of input parameters can be passed to this function but every output +variable name should have a matching value argument. + +

+
Parameters:
- ActionName The action name. +
ServType - The service type. +
NumArg - The number of argument pairs passed. +
Arg - The status variable name and value pair.
Returns:
[IXML_Document*] The action node of Upnp_Document type or +NULL if the operation failed. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpNotify.html b/docs/dist/html/upnp/UpnpNotify.html new file mode 100644 index 0000000..a746eab --- /dev/null +++ b/docs/dist/html/upnp/UpnpNotify.html @@ -0,0 +1,50 @@ + + + + + EXPORT_SPEC int UpnpNotify + + + + +

EXPORT_SPEC int UpnpNotify

( IN UpnpDevice_Handle,
  IN const char* DevID,
  IN const char* ServID,
  IN const char** VarName,
  IN const char** NewVal,
  IN int cVariables )

UpnpNotify sends out an event change notification to all control points subscribed to a particular service.
+ + +
+

Documentation

+
UpnpNotify sends out an event change notification to all +control points subscribed to a particular service. This function is +synchronous and generates no callbacks. + +

UpnpNotify may be called during a callback function to send out +a notification. + +

+
Parameters:
- UpnpDevice_Handle The handle to the device sending the event. +
DevID - The device ID of the subdevice of the service +generating the event. +
ServID - The unique identifier of the service +generating the event. +
VarName - Pointer to an array of variables that +have changed. +
NewVal - Pointer to an array of new values for +those variables. +
cVariables - The count of variables included in this +notification.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid device +handle. +
  • UPNP_E_INVALID_SERVICE: The DevId/ServId +pair refers to an invalid service. +
  • UPNP_E_INVALID_PARAM: Either VarName, NewVal, +DevID, or ServID is not a valid pointer or +cVariables is less than zero. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpNotifyExt.html b/docs/dist/html/upnp/UpnpNotifyExt.html new file mode 100644 index 0000000..6e0c971 --- /dev/null +++ b/docs/dist/html/upnp/UpnpNotifyExt.html @@ -0,0 +1,50 @@ + + + + + EXPORT_SPEC int UpnpNotifyExt + + + + +

EXPORT_SPEC int UpnpNotifyExt

( IN UpnpDevice_Handle,
  IN const char* DevID,
  IN const char* ServID,
  IN IXML_Document* PropSet )

UpnpNotifyExt is similar to UpnpNotify except that it takes a DOM document for the event rather than an array of strings.
+ + +
+

Documentation

+
UpnpNotifyExt is similar to UpnpNotify except that it takes +a DOM document for the event rather than an array of strings. This +function is synchronous and generates no callbacks. + +

UpnpNotifyExt may be called during a callback function to send out +a notification. + +

+
Parameters:
- UpnpDevice_Handle The handle to the device sending the +event. +
DevID - The device ID of the subdevice of the +service generating the event. +
ServID - The unique identifier of the service +generating the event. +
PropSet - The DOM document for the property set. +Property set documents must conform to +the XML schema defined in section 4.3 of +the Universal Plug and Play Device +Architecture specification.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid device +handle. +
  • UPNP_E_INVALID_SERVICE: The DevId/ServId +pair refers to an invalid service. +
  • UPNP_E_INVALID_PARAM: Either VarName, NewVal, +DevID, ServID, or PropSet +is not a valid pointer or cVariables is less than zero. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpOpenHttpGet.html b/docs/dist/html/upnp/UpnpOpenHttpGet.html new file mode 100644 index 0000000..ac5865d --- /dev/null +++ b/docs/dist/html/upnp/UpnpOpenHttpGet.html @@ -0,0 +1,60 @@ + + + + + EXPORT_SPEC int UpnpOpenHttpGet + + + + +

EXPORT_SPEC int UpnpOpenHttpGet

( IN const char* url,
  IN OUT void** handle,
  IN OUT char** contentType,
  IN OUT int* contentLength,
  IN OUT int* httpStatus,
  IN int timeout )

UpnpOpenHttpGet gets a file specified in a URL.
+ + +
+

Documentation

+
UpnpOpenHttpGet gets a file specified in a URL. +The SDK allocates the memory for handle and +contentType, the application is responsible for freeing this memory. + +

+
Parameters:
url - The URL of an item to get. +
handle - A pointer to store the handle for +this connection. +
contentType - A buffer to store the media type of +the item. +
contentLength - A pointer to store the length of the +item. +
httpStatus - The status returned on receiving a +response message. +
timeout - The time out value sent with the +request during which a response is +expected from the server, failing +which, an error is reported back to +the user.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: Either url, handle, +contentType, contentLength or httpStatus +is not a valid pointer. +
  • UPNP_E_INVALID_URL: The url is not a valid +URL. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +download this file. +
  • UPNP_E_NETWORK_ERROR: A network error occurred. +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket. +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket. +
  • UPNP_E_SOCKET_BIND: An error occurred binding a socket. +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting a +socket. +
  • UPNP_E_OUTOF_SOCKET: Too many sockets are currently +allocated. +
  • UPNP_E_BAD_RESPONSE: A bad response was received from the +remote server. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpOpenHttpGetEx.html b/docs/dist/html/upnp/UpnpOpenHttpGetEx.html new file mode 100644 index 0000000..0ccc6ad --- /dev/null +++ b/docs/dist/html/upnp/UpnpOpenHttpGetEx.html @@ -0,0 +1,66 @@ + + + + + EXPORT_SPEC int UpnpOpenHttpGetEx + + + + +

EXPORT_SPEC int UpnpOpenHttpGetEx

( IN const char* url,
  IN OUT void** handle,
  IN OUT char** contentType,
  IN OUT int* contentLength,
  IN OUT int* httpStatus,
  IN int lowRange,
  IN int highRange,
  IN int timeout )

UpnpOpenHttpGetEx gets specified number of bytes from a file specified in the URL.
+ + +
+

Documentation

+
UpnpOpenHttpGetEx gets specified number of bytes from a file +specified in the URL. The number of bytes is specified through a low +count and a high count which are passed as a range of bytes for the +request. The SDK allocates the memory for handle and +contentType, the application is responsible for freeing this memory. + +

+
Parameters:
url - The URL of the item to get. +
handle - A pointer to store the handle for +this connection. +
contentType - A buffer to store the media type of the +item. +
contentLength - A buffer to store the length of the +item. +
httpStatus - The status returned on receiving a +response message from the remote +server. +
lowRange - An integer value representing the low +end of a range to retrieve. +
highRange - An integer value representing the high +end of a range to retrieve. +
timeout - A time out value sent with the request +during which a response is expected +from the server, failing which, an +error is reported back to the user.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: Either url, handle, +contentType, contentLength or httpStatus +is not a valid pointer. +
  • UPNP_E_INVALID_URL: The url is not a valid +URL. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +download this file. +
  • UPNP_E_NETWORK_ERROR: A network error occurred. +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket. +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket. +
  • UPNP_E_SOCKET_BIND: An error occurred binding a socket. +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting a +socket. +
  • UPNP_E_OUTOF_SOCKET: Too many sockets are currently +allocated. +
  • UPNP_E_BAD_RESPONSE: A bad response was received from the +remote server. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpOpenHttpGetProxy.html b/docs/dist/html/upnp/UpnpOpenHttpGetProxy.html new file mode 100644 index 0000000..29909f5 --- /dev/null +++ b/docs/dist/html/upnp/UpnpOpenHttpGetProxy.html @@ -0,0 +1,62 @@ + + + + + EXPORT_SPEC int UpnpOpenHttpGetProxy + + + + +

EXPORT_SPEC int UpnpOpenHttpGetProxy

( IN const char* url,
  IN const char* proxy_str,
  IN OUT void** handle,
  IN OUT char** contentType,
  IN OUT int* contentLength,
  IN OUT int* httpStatus,
  IN int timeout )

UpnpOpenHttpGetProxy gets a file specified in a URL through the specified proxy.
+ + +
+

Documentation

+
UpnpOpenHttpGetProxy gets a file specified in a URL through the +specified proxy. +The SDK allocates the memory for handle and +contentType, the application is responsible for freeing this memory. + +

+
Parameters:
url - The URL of an item to get. +
proxy_str - The URL of the proxy. +
handle - A pointer to store the handle for +this connection. +
contentType - A buffer to store the media type of +the item. +
contentLength - A pointer to store the length of the +item. +
httpStatus - The status returned on receiving a +response message. +
timeout - The time out value sent with the +request during which a response is +expected from the server, failing +which, an error is reported back to +the user.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: Either url, handle, +contentType, contentLength or httpStatus +is not a valid pointer. +
  • UPNP_E_INVALID_URL: The url is not a valid +URL. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +download this file. +
  • UPNP_E_NETWORK_ERROR: A network error occurred. +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket. +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket. +
  • UPNP_E_SOCKET_BIND: An error occurred binding a socket. +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting a +socket. +
  • UPNP_E_OUTOF_SOCKET: Too many sockets are currently +allocated. +
  • UPNP_E_BAD_RESPONSE: A bad response was received from the +remote server. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpOpenHttpPost.html b/docs/dist/html/upnp/UpnpOpenHttpPost.html new file mode 100644 index 0000000..033f384 --- /dev/null +++ b/docs/dist/html/upnp/UpnpOpenHttpPost.html @@ -0,0 +1,57 @@ + + + + + EXPORT_SPEC int UpnpOpenHttpPost + + + + +

EXPORT_SPEC int UpnpOpenHttpPost

( IN const char* url,
  IN OUT void** handle,
  IN const char* contentType,
  IN int contentLength,
  IN int timeout )

UpnpOpenHttpPost makes an HTTP POST request message, opens a connection to the server and sends the POST request to the server if the connection to the server succeeds.
+ + +
+

Documentation

+
UpnpOpenHttpPost makes an HTTP POST request message, opens a +connection to the server and sends the POST request to the server if +the connection to the server succeeds. +The SDK allocates the memory for handle and +contentType, the application is responsible for freeing this memory. + +

+
Parameters:
url - The URL in which to send the POST +request. +
handle - A pointer in which to store the +handle for this connection. This +handle is required for futher +operations over this connection. +
contentType - A buffer to store the media type of +content being sent. +
contentLength - The length of the content, in bytes, +being posted. +
timeout - The time out value sent with the +request during which a response is +expected from the receiver, failing +which, an error is reported.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: Either url, handle +or contentType is not a valid pointer. +
  • UPNP_E_INVALID_URL: The url is not a valid +URL. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +download this file. +
  • UPNP_E_SOCKET_ERROR: Error occured allocating a socket and +resources or an error occurred binding a socket. +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket. +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting a +socket. +
  • UPNP_E_OUTOF_SOCKET: Too many sockets are currently +allocated. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpReadHttpGet.html b/docs/dist/html/upnp/UpnpReadHttpGet.html new file mode 100644 index 0000000..0cafaf2 --- /dev/null +++ b/docs/dist/html/upnp/UpnpReadHttpGet.html @@ -0,0 +1,45 @@ + + + + + EXPORT_SPEC int UpnpReadHttpGet + + + + +

EXPORT_SPEC int UpnpReadHttpGet

( IN void* handle,
  IN OUT char* buf,
  IN OUT unsigned int* size,
  IN int timeout )

UpnpReadHttpGet gets specified number of bytes from a file specified in a URL.
+ + +
+

Documentation

+
UpnpReadHttpGet gets specified number of bytes from a file +specified in a URL. + +

+
Parameters:
handle - The token created by the call to +UpnpOpenHttpGet. +
buf - The buffer to store the read item. +
size - The size of the buffer to be read. +
timeout - The time out value sent with the +request during which a response is +expected from the server, failing +which, an error is reported back to +the user.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: Either handle, buf +or size is not a valid pointer. +
  • UPNP_E_BAD_RESPONSE: A bad response was received from the +remote server. +
  • UPNP_E_BAD_HTTPMSG: Either the request or response was in +the incorrect format. +
  • UPNP_E_CANCELED: another thread called UpnpCancelHttpGet. +
+Note: In case of return values, the status code parameter of the passed +in handle value may provide additional information on the return +value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpRegisterClient.html b/docs/dist/html/upnp/UpnpRegisterClient.html new file mode 100644 index 0000000..894a330 --- /dev/null +++ b/docs/dist/html/upnp/UpnpRegisterClient.html @@ -0,0 +1,42 @@ + + + + + EXPORT_SPEC int UpnpRegisterClient + + + + +

EXPORT_SPEC int UpnpRegisterClient

( IN Upnp_FunPtr Callback,
  IN const void* Cookie,
  OUT UpnpClient_Handle* Hnd )

UpnpRegisterClient registers a control point application with the SDK.
+ + +
+

Documentation

+
UpnpRegisterClient registers a control point application with the +SDK. A control point application cannot make any other API calls +until it registers using this function. + +

UpnpRegisterClient is a synchronous call and generates no callbacks. +Callbacks can occur as soon as this function returns. + +

+
Parameters:
Callback - Pointer to a function for receiving +asynchronous events. +
Cookie - Pointer to user data returned with the +callback function when invoked. +
Hnd - Pointer to a variable to store the +new control point handle.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_FINISH: The SDK is already terminated or +is not initialized. +
  • UPNP_E_INVALID_PARAM: Either Callback or Hnd +is not a valid pointer. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +register this control point. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpRegisterRootDevice.html b/docs/dist/html/upnp/UpnpRegisterRootDevice.html new file mode 100644 index 0000000..069a43c --- /dev/null +++ b/docs/dist/html/upnp/UpnpRegisterRootDevice.html @@ -0,0 +1,62 @@ + + + + + EXPORT_SPEC int UpnpRegisterRootDevice + + + + +

EXPORT_SPEC int UpnpRegisterRootDevice

( IN const char* DescUrl,
  IN Upnp_FunPtr Callback,
  IN const void* Cookie,
  OUT UpnpDevice_Handle* Hnd )

UpnpRegisterRootDevice registers a device application with the SDK.
+ + +
+

Documentation

+
UpnpRegisterRootDevice registers a device application with +the SDK. A device application cannot make any other API +calls until it registers using this function. Device applications +can also register as control points (see UpnpRegisterClient +to get a control point handle to perform control point +functionality). + +

UpnpRegisterRootDevice is synchronous and does not generate +any callbacks. Callbacks can occur as soon as this function returns. + +

+
Parameters:
DescUrl - Pointer to a string containing the +description URL for this root device +instance. +
Callback - Pointer to the callback function for +receiving asynchronous events. +
Cookie - Pointer to user data returned with the +callback function when invoked. +
Hnd - Pointer to a variable to store the +new device handle.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_FINISH: The SDK is already terminated or +is not initialized. +
  • UPNP_E_INVALID_DESC: The description document was not +a valid device description. +
  • UPNP_E_INVALID_URL: The URL for the description document +is not valid. +
  • UPNP_E_INVALID_PARAM: Either Callback or Hnd +is not a valid pointer or DescURL is NULL. +
  • UPNP_E_NETWORK_ERROR: A network error occurred. +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket. +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket. +
  • UPNP_E_SOCKET_BIND: An error occurred binding a socket. +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting the +socket. +
  • UPNP_E_OUTOF_SOCKET: Too many sockets are currently +allocated. +
  • UPNP_E_OUTOF_MEMORY: There are insufficient resources to +register this root device. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpRegisterRootDevice2.html b/docs/dist/html/upnp/UpnpRegisterRootDevice2.html new file mode 100644 index 0000000..60b9532 --- /dev/null +++ b/docs/dist/html/upnp/UpnpRegisterRootDevice2.html @@ -0,0 +1,106 @@ + + + + + EXPORT_SPEC int UpnpRegisterRootDevice2 + + + + +

EXPORT_SPEC int UpnpRegisterRootDevice2

( IN Upnp_DescType descriptionType,
  IN const char* description,
  IN size_t bufferLen,
  IN int config_baseURL,
  IN Upnp_FunPtr Fun,
  IN const void* Cookie,
  OUT UpnpDevice_Handle* Hnd )

UpnpRegisterRootDevice2 is similar to UpnpRegisterRootDevice, except that it also allows the description document to be specified as a file or a memory buffer.
+ + +
+

Documentation

+
UpnpRegisterRootDevice2 is similar to UpnpRegisterRootDevice, +except that it also allows the description document to be specified as a +file or a memory buffer. The description can also be configured to have the +correct IP and port address. + +

NOTE: For the configuration to be functional, the internal web server +MUST be present. In addition, the web server MUST be activated +(using UpnpSetWebServerRootDir) before calling this function. +The only condition where the web server can be absent is if the +description document is specified as a URL and no configuration is +required (i.e. config_baseURL = 0.) + +

UpnpRegisterRootDevice2 is synchronous and does not generate +any callbacks. Callbacks can occur as soon as this function returns. + +

Examples of using different types of description documents: +

+    1) Description specified as a URL:
+          descriptionType == UPNPREG_URL_DESC
+          description is the URL
+          bufferLen = 0 (ignored)
+    2) Description specified as a file:
+          descriptionType == UPNPREG_FILENAME_DESC
+          description is a filename
+          bufferLen = 0 (ignored)
+    3) Description specified as a memory buffer:
+          descriptionType == UPNPREG_BUF_DESC
+          description is pointer to a memory buffer
+          bufferLen == length of memory buffer
+    
+ +

+
Parameters:
descriptionType - The type of the description +document. +
description - Treated as a URL, file name or +memory buffer depending on +description type. +
bufferLen - The length of memory buffer if +passing a description in a buffer, +otherwise it is ignored. +
config_baseURL - If nonzero, URLBase of +description document is +configured and the description +is served using the internal +web server. +
Fun - Pointer to the callback function +for receiving asynchronous +events. +
Cookie - Pointer to user data returned +with the callback function when +invoked. +
Hnd - Pointer to a variable to store +the new device handle.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_FINISH: The SDK is already terminated or +is not initialized. +
  • UPNP_E_INVALID_DESC: The description document is not +a valid device description. +
  • UPNP_E_INVALID_PARAM: Either Callback or Hnd +is not a valid pointer or DescURL is NULL. +
  • UPNP_E_NETWORK_ERROR: A network error occurred. +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket. +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket. +
  • UPNP_E_SOCKET_BIND: An error occurred binding a socket. +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting the +socket. +
  • UPNP_E_OUTOF_SOCKET: Too many sockets are currently +allocated. +
  • UPNP_E_OUTOF_MEMORY: There are insufficient resources to +register this root device. +
  • UPNP_E_URL_TOO_BIG: Length of the URL is bigger than the +internal buffer. +
  • UPNP_E_FILE_NOT_FOUND: The description file could not +be found. +
  • UPNP_E_FILE_READ_ERROR: An error occurred reading the +description file. +
  • UPNP_E_INVALID_URL: The URL to the description document +is invalid. +
  • UPNP_E_EXT_NOT_XML: The URL to the description document +or file should have a .xml extension. +
  • UPNP_E_NO_WEB_SERVER: The internal web server has been +compiled out; the SDK cannot configure itself from the +description document. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpRemoveAllVirtualDirs.html b/docs/dist/html/upnp/UpnpRemoveAllVirtualDirs.html new file mode 100644 index 0000000..e7a9fba --- /dev/null +++ b/docs/dist/html/upnp/UpnpRemoveAllVirtualDirs.html @@ -0,0 +1,23 @@ + + + + + EXPORT_SPEC void UpnpRemoveAllVirtualDirs + + + + +

EXPORT_SPEC void UpnpRemoveAllVirtualDirs

( )

UpnpRemoveAllVirtualDirs removes all virtual directory mappings.
+ + +
+

Documentation

+
UpnpRemoveAllVirtualDirs removes all virtual directory mappings. + +

+
Returns:
[void] This function does not return a value. +

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpRemoveVirtualDir.html b/docs/dist/html/upnp/UpnpRemoveVirtualDir.html new file mode 100644 index 0000000..7accd97 --- /dev/null +++ b/docs/dist/html/upnp/UpnpRemoveVirtualDir.html @@ -0,0 +1,29 @@ + + + + + EXPORT_SPEC int UpnpRemoveVirtualDir + + + + +

EXPORT_SPEC int UpnpRemoveVirtualDir

( IN const char* dirName )

UpnpRemoveVirtualDir removes a virtual directory mapping made with UpnpAddVirtualDir.
+ + +
+

Documentation

+
UpnpRemoveVirtualDir removes a virtual directory mapping made with +UpnpAddVirtualDir. + +

+
Parameters:
dirName - The name of the virtual directory mapping to +remove.
Returns:
[int] An integer representing one of the following: +
    +
  • UPPN_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_ARGUMENT: dirName is not valid. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpRenewSubscription.html b/docs/dist/html/upnp/UpnpRenewSubscription.html new file mode 100644 index 0000000..b193074 --- /dev/null +++ b/docs/dist/html/upnp/UpnpRenewSubscription.html @@ -0,0 +1,52 @@ + + + + + EXPORT_SPEC int UpnpRenewSubscription + + + + +

EXPORT_SPEC int UpnpRenewSubscription

( IN UpnpClient_Handle Hnd,
  INOUT int* TimeOut,
  IN Upnp_SID SubsId )

UpnpRenewSubscription renews a subscription that is about to expire.
+ + +
+

Documentation

+
UpnpRenewSubscription renews a subscription that is about to +expire. This function is synchronous. + +

+
Parameters:
Hnd - The handle of the control point that +is renewing the subscription. +
- TimeOut Pointer to a variable containing the +requested subscription time. Upon return, +it contains the actual renewal time. +
SubsId - The ID for the subscription to renew.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_PARAM: Timeout is not a valid pointer. +
  • UPNP_E_INVALID_SID: The SID being passed to this function +is not a valid subscription ID. +
  • UPNP_E_NETWORK_ERROR: A network error occured. +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket. +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket. +
  • UPNP_E_SOCKET_BIND: An error occurred binding a socket. +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting to +PublisherUrl. +
  • UPNP_E_OUTOF_SOCKET: An error occurred creating a socket. +
  • UPNP_E_BAD_RESPONSE: An error occurred in response from +the publisher. +
  • UPNP_E_SUBSCRIBE_UNACCEPTED: The publisher refused +the subscription renew. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpRenewSubscriptionAsync.html b/docs/dist/html/upnp/UpnpRenewSubscriptionAsync.html new file mode 100644 index 0000000..eebd490 --- /dev/null +++ b/docs/dist/html/upnp/UpnpRenewSubscriptionAsync.html @@ -0,0 +1,76 @@ + + + + + EXPORT_SPEC int UpnpRenewSubscriptionAsync + + + + +

EXPORT_SPEC int UpnpRenewSubscriptionAsync

( IN UpnpClient_Handle Hnd,
  IN int TimeOut,
  IN Upnp_SID SubsId,
  IN Upnp_FunPtr Fun,
  IN const void* Cookie )

UpnpRenewSubscriptionAsync renews a subscription that is about to expire, generating a callback when the operation is complete.
+ + +
+

Documentation

+
UpnpRenewSubscriptionAsync renews a subscription that is about +to expire, generating a callback when the operation is complete. + +

Note that many of the error codes for this function are returned in +the Upnp_Event_Subscribe structure. In those cases, the function +returns UPNP_E_SUCCESS and the appropriate error code will +be in the Upnp_Event_Subscribe.ErrCode field in the Event +structure passed to the callback. + +

+
Parameters:
Hnd - The handle of the control point that +is renewing the subscription. +
- TimeOut The requested subscription time. The +actual timeout value is returned when +the callback function is called. +
SubsId - The ID for the subscription to renew. +
Fun - Pointer to a callback function to be +invoked when the renewal is complete. +
Cookie - Pointer to user data passed +to the callback function when invoked.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_SID: The SubsId is not a valid +subscription ID. +
  • UPNP_E_INVALID_PARAM: Either Fun is not a valid +callback function pointer or Timeout is less than zero +but is not UPNP_INFINITE. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
  • UPNP_E_NETWORK_ERROR: A network error occured (returned in +the Upnp_Event_Subscribe.ErrCode field as part of the +callback). +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket (returned in the Upnp_Event_Subscribe.ErrCode +field as part of the callback). +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the +callback). +
  • UPNP_E_SOCKET_BIND: An error occurred binding the socket +(returned in the Upnp_Event_Subscribe.ErrCode field as +part of the callback). +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting to +PublisherUrl (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the callback). +
  • UPNP_E_OUTOF_SOCKET: An error occurred creating socket ( +returned in the Upnp_Event_Subscribe.ErrCode field as +part of the callback). +
  • UPNP_E_BAD_RESPONSE: An error occurred in response from +the publisher (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the callback). +
  • UPNP_E_SUBSCRIBE_UNACCEPTED: The publisher refused +the subscription request (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the callback). +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpResolveURL.html b/docs/dist/html/upnp/UpnpResolveURL.html new file mode 100644 index 0000000..dd893bf --- /dev/null +++ b/docs/dist/html/upnp/UpnpResolveURL.html @@ -0,0 +1,37 @@ + + + + + EXPORT_SPEC int UpnpResolveURL + + + + +

EXPORT_SPEC int UpnpResolveURL

( IN const char* BaseURL,
  IN const char* RelURL,
  OUT char* AbsURL )

UpnpResolveURL combines a base URL and a relative URL into a single absolute URL.
+ + +
+

Documentation

+
UpnpResolveURL combines a base URL and a relative URL into +a single absolute URL. The memory for AbsURL needs to be +allocated by the caller and must be large enough to hold the +BaseURL and RelURL combined. + +

+
Parameters:
BaseURL - The base URL to combine. +
RelURL - The relative URL to BaseURL. +
AbsURL - A pointer to a buffer to store the +absolute URL.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: RelURL is NULL. +
  • UPNP_E_INVALID_URL: The BaseURL / RelURL +combination does not form a valid URL. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSearchAsync.html b/docs/dist/html/upnp/UpnpSearchAsync.html new file mode 100644 index 0000000..c12ee80 --- /dev/null +++ b/docs/dist/html/upnp/UpnpSearchAsync.html @@ -0,0 +1,50 @@ + + + + + EXPORT_SPEC int UpnpSearchAsync + + + + +

EXPORT_SPEC int UpnpSearchAsync

( IN UpnpClient_Handle Hnd,
  IN int Mx,
  IN const char* Target,
  IN const void* Cookie )

UpnpSearchAsync searches for devices matching the given search target.
+ + +
+

Documentation

+
UpnpSearchAsync searches for devices matching the given +search target. The function returns immediately and the SDK +calls the default callback function, registered during the +UpnpRegisterClient call, for each matching root device, +device, or service. The application specifies the search type by the +Target parameter. + +

Note that there is no way for the SDK to distinguish which client +instance issued a particular search. Therefore, the client can get +search callbacks that do not match the original criteria of the search. +Also, the application will receive multiple callbacks for each search. + +

+
Parameters:
Hnd - The handle of the client performing +the search. +
Mx - The time, in seconds, to wait for +responses. If the time is greater +than MAX_SEARCH_TIME then the time is +set to MAX_SEARCH_TIME. If the time is +less than MIN_SEARCH_TIME then the +time is set to MIN_SEARCH_TIME. +
Target - The search target as defined in the UPnP +Device Architecture v1.0 specification. +
Cookie - The user data to pass when the callback +function is invoked.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_PARAM: Target is NULL. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSendAction.html b/docs/dist/html/upnp/UpnpSendAction.html new file mode 100644 index 0000000..f36d478 --- /dev/null +++ b/docs/dist/html/upnp/UpnpSendAction.html @@ -0,0 +1,53 @@ + + + + + EXPORT_SPEC int UpnpSendAction + + + + +

EXPORT_SPEC int UpnpSendAction

( IN UpnpClient_Handle Hnd,
  IN const char* ActionURL,
  IN const char* ServiceType,
  IN const char* DevUDN,
  IN IXML_Document* Action,
  OUT IXML_Document** RespNode )

UpnpSendAction sends a message to change a state variable in a service.
+ + +
+

Documentation

+
UpnpSendAction sends a message to change a state variable +in a service. This is a synchronous call that does not return until the +action is complete. + +

Note that a positive return value indicates a SOAP-protocol error code. +In this case, the error description can be retrieved from RespNode. +A negative return value indicates an SDK error. + +

+
Parameters:
Hnd - The handle of the control point +sending the action. +
ActionURL - The action URL of the service. +
- ServiceType The type of the service. +
- DevUDN This parameter is ignored and must be +NULL. +
Action - The DOM document for the action. +
RespNode - The DOM document for the response +to the action. The SDK allocates +this document and the caller needs to free +it.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_URL: ActionUrl is not a valid URL. +
  • UPNP_E_INVALID_ACTION: This action is not valid. +
  • UPNP_E_INVALID_DEVICE: DevUDN is not a +valid device. +
  • UPNP_E_INVALID_PARAM: ServiceType, Action, +ActionUrl, or +RespNode is not a valid pointer. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSendActionAsync.html b/docs/dist/html/upnp/UpnpSendActionAsync.html new file mode 100644 index 0000000..512a23d --- /dev/null +++ b/docs/dist/html/upnp/UpnpSendActionAsync.html @@ -0,0 +1,52 @@ + + + + + EXPORT_SPEC int UpnpSendActionAsync + + + + +

EXPORT_SPEC int UpnpSendActionAsync

( IN UpnpClient_Handle Hnd,
  IN const char* ActionURL,
  IN const char* ServiceType,
  IN const char* DevUDN,
  IN IXML_Document* Action,
  IN Upnp_FunPtr Fun,
  IN const void* Cookie )

UpnpSendActionAsync sends a message to change a state variable in a service, generating a callback when the operation is complete.
+ + +
+

Documentation

+
UpnpSendActionAsync sends a message to change a state variable +in a service, generating a callback when the operation is complete. +See UpnpSendAction for comments on positive return values. These +positive return values are sent in the event struct associated with the +UPNP_CONTROL_ACTION_COMPLETE event. + +

+
Parameters:
Hnd - The handle of the control point +sending the action. +
ActionURL - The action URL of the service. +
- ServiceType The type of the service. +
- DevUDN This parameter is ignored and must be +NULL. +
Action - The DOM document for the action to +perform on this device. +
Fun - Pointer to a callback function to +be invoked when the operation +completes. +
Cookie - Pointer to user data that to be +passed to the callback when invoked.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_URL: ActionUrl is an invalid URL. +
  • UPNP_E_INVALID_DEVICE: DevUDN is an invalid device. +
  • UPNP_E_INVALID_PARAM: Either Fun is not a valid +callback function or ServiceType, Act, or +ActionUrl is NULL. +
  • UPNP_E_INVALID_ACTION: This action is not valid. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSendActionEx.html b/docs/dist/html/upnp/UpnpSendActionEx.html new file mode 100644 index 0000000..71baa3b --- /dev/null +++ b/docs/dist/html/upnp/UpnpSendActionEx.html @@ -0,0 +1,56 @@ + + + + + EXPORT_SPEC int UpnpSendActionEx + + + + +

EXPORT_SPEC int UpnpSendActionEx

( IN UpnpClient_Handle Hnd,
  IN const char* ActionURL,
  IN const char* ServiceType,
  IN const char* DevUDN,
  IN IXML_Document* Header,
  IN IXML_Document* Action,
  OUT IXML_Document** RespNode )

UpnpSendActionEx sends a message to change a state variable in a service.
+ + +
+

Documentation

+
UpnpSendActionEx sends a message to change a state variable +in a service. This is a synchronous call that does not return until the +action is complete. + +

Note that a positive return value indicates a SOAP-protocol error code. +In this case, the error description can be retrieved from RespNode. +A negative return value indicates an SDK error. + +

+
Parameters:
Hnd - The handle of the control point +sending the action. +
ActionURL - The action URL of the service. +
- ServiceType The type of the service. +
- DevUDN This parameter is ignored and must be +NULL. +
Header - The DOM document for the SOAP header. +This may be NULL if the header is +not required. +
Action - The DOM document for the action. +
RespNode - The DOM document for the response +to the action. The SDK allocates +this document and the caller needs to free +it.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_URL: ActionUrl is not a valid URL. +
  • UPNP_E_INVALID_ACTION: This action is not valid. +
  • UPNP_E_INVALID_DEVICE: DevUDN is not a +valid device. +
  • UPNP_E_INVALID_PARAM: ServiceType, Action, +ActionUrl, or +RespNode is not a valid pointer. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSendActionExAsync.html b/docs/dist/html/upnp/UpnpSendActionExAsync.html new file mode 100644 index 0000000..2d143e1 --- /dev/null +++ b/docs/dist/html/upnp/UpnpSendActionExAsync.html @@ -0,0 +1,55 @@ + + + + + EXPORT_SPEC int UpnpSendActionExAsync + + + + +

EXPORT_SPEC int UpnpSendActionExAsync

( IN UpnpClient_Handle Hnd,
  IN const char* ActionURL,
  IN const char* ServiceType,
  IN const char* DevUDN,
  IN IXML_Document* Header,
  IN IXML_Document* Action,
  IN Upnp_FunPtr Fun,
  IN const void* Cookie )

UpnpSendActionExAsync sends a message to change a state variable in a service, generating a callback when the operation is complete.
+ + +
+

Documentation

+
UpnpSendActionExAsync sends a message to change a state variable +in a service, generating a callback when the operation is complete. +See UpnpSendAction for comments on positive return values. These +positive return values are sent in the event struct associated with the +UPNP_CONTROL_ACTION_COMPLETE event. + +

+
Parameters:
Hnd - The handle of the control point +sending the action. +
ActionURL - The action URL of the service. +
- ServiceType The type of the service. +
- DevUDN This parameter is ignored and must be +NULL. +
Header - The DOM document for the SOAP header. +This may be NULL if the header is +not required. +
Action - The DOM document for the action to +perform on this device. +
Fun - Pointer to a callback function to +be invoked when the operation +completes. +
Cookie - Pointer to user data that to be +passed to the callback when invoked.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_URL: ActionUrl is an invalid URL. +
  • UPNP_E_INVALID_DEVICE: DevUDN is an invalid device. +
  • UPNP_E_INVALID_PARAM: Either Fun is not a valid +callback function or ServiceType, Act, or +ActionUrl is NULL. +
  • UPNP_E_INVALID_ACTION: This action is not valid. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSendAdvertisement.html b/docs/dist/html/upnp/UpnpSendAdvertisement.html new file mode 100644 index 0000000..a72d619 --- /dev/null +++ b/docs/dist/html/upnp/UpnpSendAdvertisement.html @@ -0,0 +1,37 @@ + + + + + EXPORT_SPEC int UpnpSendAdvertisement + + + + +

EXPORT_SPEC int UpnpSendAdvertisement

( IN UpnpDevice_Handle Hnd,
  IN int Exp )

UpnpSendAdvertisement sends out the discovery announcements for all devices and services for a device.
+ + +
+

Documentation

+
UpnpSendAdvertisement sends out the discovery announcements for +all devices and services for a device. Each announcement is made with +the same expiration time. + +

UpnpSendAdvertisement is a synchronous call. + +

+
Parameters:
Hnd - The device handle for which to send out the +announcements. +
Exp - The expiration age, in seconds, of +the announcements.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid +device handle. +
  • UPNP_E_OUTOF_MEMORY: There are insufficient resources to +send future advertisements. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSetContentLength.html b/docs/dist/html/upnp/UpnpSetContentLength.html new file mode 100644 index 0000000..a9350ba --- /dev/null +++ b/docs/dist/html/upnp/UpnpSetContentLength.html @@ -0,0 +1,23 @@ + + + + + EXPORT_SPEC int UpnpSetContentLength + + + + +

EXPORT_SPEC int UpnpSetContentLength

( IN UpnpClient_Handle Hnd,
  IN int contentLength )

OBSOLETE METHOD : use UpnpSetMaxContentLength instead.
+ + +
+

Documentation

+
OBSOLETE METHOD : use UpnpSetMaxContentLength instead. +Warning: the Handle argument provided here is not used, so the effect +of this function is global to the SDK (= same as +UpnpSetMaxContentLength ).
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSetMaxContentLength.html b/docs/dist/html/upnp/UpnpSetMaxContentLength.html new file mode 100644 index 0000000..e6347a3 --- /dev/null +++ b/docs/dist/html/upnp/UpnpSetMaxContentLength.html @@ -0,0 +1,32 @@ + + + + + EXPORT_SPEC int UpnpSetMaxContentLength + + + + +

EXPORT_SPEC int UpnpSetMaxContentLength

( IN size_t contentLength )

Sets the maximum content-length that the SDK will process on an incoming SOAP requests or responses.
+ + +
+

Documentation

+
Sets the maximum content-length that the SDK will process on an incoming +SOAP requests or responses. This API allows devices that have memory +constraints to exhibit consistent behaviour if the size of the +incoming SOAP message exceeds the memory that device can allocate. +The default maximum content-length is DEFAULT_SOAP_CONTENT_LENGTH += 16K bytes. + +

+
Parameters:
contentLength - The maximum permissible content length +for incoming SOAP actions, in bytes.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSetMaxSubscriptionTimeOut.html b/docs/dist/html/upnp/UpnpSetMaxSubscriptionTimeOut.html new file mode 100644 index 0000000..04857ec --- /dev/null +++ b/docs/dist/html/upnp/UpnpSetMaxSubscriptionTimeOut.html @@ -0,0 +1,37 @@ + + + + + EXPORT_SPEC int UpnpSetMaxSubscriptionTimeOut + + + + +

EXPORT_SPEC int UpnpSetMaxSubscriptionTimeOut

( IN UpnpDevice_Handle Hnd,
  IN int MaxSubscriptionTimeOut )

UpnpSetMaxSubscriptionTimeOut sets the maximum time-out accepted for a subscription request or renewal.
+ + +
+

Documentation

+
UpnpSetMaxSubscriptionTimeOut sets the maximum time-out accepted +for a subscription request or renewal. The default value accepts the +time-out set by the control point. If a control point requests a +subscription time-out less than or equal to the maximum, the SDK +grants the value requested by the control point. If the time-out +is greater, the SDK returns the maximum value. + +

+
Parameters:
Hnd - The handle of the device for which +the maximum subscription time-out is +being set. +
MaxSubscriptionTimeOut - The maximum subscription time-out to +be accepted.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid device +handle. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSetMaxSubscriptions.html b/docs/dist/html/upnp/UpnpSetMaxSubscriptions.html new file mode 100644 index 0000000..b52524c --- /dev/null +++ b/docs/dist/html/upnp/UpnpSetMaxSubscriptions.html @@ -0,0 +1,37 @@ + + + + + EXPORT_SPEC int UpnpSetMaxSubscriptions + + + + +

EXPORT_SPEC int UpnpSetMaxSubscriptions

( IN UpnpDevice_Handle Hnd,
  IN int MaxSubscriptions )

UpnpSetMaxSubscriptions sets the maximum number of subscriptions accepted per service.
+ + +
+

Documentation

+
UpnpSetMaxSubscriptions sets the maximum number of subscriptions +accepted per service. The default value accepts as many as system +resources allow. If the number of current subscriptions for a service is +greater than the requested value, the SDK accepts no new +subscriptions or renewals, however, the SDK does not remove +any current subscriptions. + +

+
Parameters:
Hnd - The handle of the device for which +the maximum number of subscriptions is +being set. +
MaxSubscriptions - The maximum number of subscriptions to be +allowed per service.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid device +handle. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSetVirtualDirCallbacks.html b/docs/dist/html/upnp/UpnpSetVirtualDirCallbacks.html new file mode 100644 index 0000000..6b7d561 --- /dev/null +++ b/docs/dist/html/upnp/UpnpSetVirtualDirCallbacks.html @@ -0,0 +1,33 @@ + + + + + EXPORT_SPEC int UpnpSetVirtualDirCallbacks + + + + +

EXPORT_SPEC int UpnpSetVirtualDirCallbacks

( IN struct UpnpVirtualDirCallbacks* callbacks )

UpnpSetVirtualDirCallbacks sets the callback function to be used to access a virtual directory.
+ + +
+

Documentation

+
UpnpSetVirtualDirCallbacks sets the callback function to be used to +access a virtual directory. Refer to the description of +UpnpVirtualDirCallbacks for a description of the functions. + +

+
Parameters:
callbacks - Pointer to a structure +containing points to the +virtual interface +functions.
Returns:
[int] An integer representing one of the following: +
    +
  • UPPN_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_ARGUMENT: callbacks is not a valid +pointer. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSetWebServerRootDir.html b/docs/dist/html/upnp/UpnpSetWebServerRootDir.html new file mode 100644 index 0000000..d3492e8 --- /dev/null +++ b/docs/dist/html/upnp/UpnpSetWebServerRootDir.html @@ -0,0 +1,38 @@ + + + + + EXPORT_SPEC int UpnpSetWebServerRootDir + + + + +

EXPORT_SPEC int UpnpSetWebServerRootDir

( IN const char* rootDir )

UpnpSetWebServerRootDir sets the document root directory for the internal web server.
+ + +
+

Documentation

+
UpnpSetWebServerRootDir sets the document root directory for +the internal web server. This directory is considered the +root directory (i.e. "/") of the web server. + +

This function also activates or deactivates the web server. +To disable the web server, pass NULL for rootDir; to +activate, pass a valid directory string. + +

Note that this function is not available when the web server is not +compiled into the SDK. + +

+
Parameters:
rootDir - Path of the root directory of the web +server.
Returns:
[int] An integer representing one of the following: +
    +
  • UPPN_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_ARGUMENT: rootDir is an invalid +directory. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSubscribe.html b/docs/dist/html/upnp/UpnpSubscribe.html new file mode 100644 index 0000000..2f1c1c5 --- /dev/null +++ b/docs/dist/html/upnp/UpnpSubscribe.html @@ -0,0 +1,55 @@ + + + + + EXPORT_SPEC int UpnpSubscribe + + + + +

EXPORT_SPEC int UpnpSubscribe

( IN UpnpClient_Handle Hnd,
  IN const char* PublisherUrl,
  INOUT int* TimeOut,
  OUT Upnp_SID SubsId )

UpnpSubscribe registers a control point to receive event notifications from another device.
+ + +
+

Documentation

+
UpnpSubscribe registers a control point to receive event +notifications from another device. This operation is synchronous. + +

+
Parameters:
Hnd - The handle of the control point. +
- PublisherUrl The URL of the service to subscribe to. +
- TimeOut Pointer to a variable containing +the requested subscription time. Upon +return, it contains the actual +subscription time returned from the +service. +
SubsId - Pointer to a variable to receive the +subscription ID (SID).
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_URL: PublisherUrl is not a valid URL. +
  • UPNP_E_INVALID_PARAM: Timeout is not a valid pointer +or SubsId or PublisherUrl is NULL. +
  • UPNP_E_NETWORK_ERROR: A network error occured. +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket. +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket. +
  • UPNP_E_SOCKET_BIND: An error occurred binding a socket. +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting to +PublisherUrl. +
  • UPNP_E_OUTOF_SOCKET: An error occurred creating a socket. +
  • UPNP_E_BAD_RESPONSE: An error occurred in response from +the publisher. +
  • UPNP_E_SUBSCRIBE_UNACCEPTED: The publisher refused +the subscription request. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpSubscribeAsync.html b/docs/dist/html/upnp/UpnpSubscribeAsync.html new file mode 100644 index 0000000..bf3864f --- /dev/null +++ b/docs/dist/html/upnp/UpnpSubscribeAsync.html @@ -0,0 +1,79 @@ + + + + + EXPORT_SPEC int UpnpSubscribeAsync + + + + +

EXPORT_SPEC int UpnpSubscribeAsync

( IN UpnpClient_Handle Hnd,
  IN const char* PublisherUrl,
  IN int TimeOut,
  IN Upnp_FunPtr Fun,
  IN const void* Cookie )

UpnpSubscribeAsync performs the same operation as UpnpSubscribe, but returns immediately and calls the registered callback function when the operation is complete.
+ + +
+

Documentation

+
UpnpSubscribeAsync performs the same operation as +UpnpSubscribe, but returns immediately and calls the registered +callback function when the operation is complete. + +

Note that many of the error codes for this function are returned in +the Upnp_Event_Subscribe structure. In those cases, the function +returns UPNP_E_SUCCESS and the appropriate error code will +be in the Upnp_Event_Subscribe.ErrCode field in the Event +structure passed to the callback. + +

+
Parameters:
Hnd - The handle of the control point that +is subscribing. +
- PublisherUrl The URL of the service to subscribe +to. +
- TimeOut The requested subscription time. Upon +return, it contains the actual +subscription time returned from the +service. +
Fun - Pointer to the callback function for +this subscribe request. +
Cookie - A user data value passed to the +callback function when invoked.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_URL: The PublisherUrl is not a valid +URL. +
  • UPNP_E_INVALID_PARAM: Either TimeOut or Fun or +PublisherUrl is not a valid pointer. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
  • UPNP_E_NETWORK_ERROR: A network error occured (returned in +the Upnp_Event_Subscribe.ErrCode field as part of the +callback). +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the +callback). +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the +callback). +
  • UPNP_E_SOCKET_BIND: An error occurred binding the socket +(returned in the Upnp_Event_Subscribe.ErrCode field as +part of the callback). +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting to +PublisherUrl (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the callback). +
  • UPNP_E_OUTOF_SOCKET: An error occurred creating the +socket (returned in the Upnp_Event_Subscribe.ErrCode +field as part of the callback). +
  • UPNP_E_BAD_RESPONSE: An error occurred in response from +the publisher (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the callback). +
  • UPNP_E_SUBSCRIBE_UNACCEPTED: The publisher refused +the subscription request (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the callback). +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpUnRegisterClient.html b/docs/dist/html/upnp/UpnpUnRegisterClient.html new file mode 100644 index 0000000..c3ffcb0 --- /dev/null +++ b/docs/dist/html/upnp/UpnpUnRegisterClient.html @@ -0,0 +1,35 @@ + + + + + EXPORT_SPEC int UpnpUnRegisterClient + + + + +

EXPORT_SPEC int UpnpUnRegisterClient

( IN UpnpClient_Handle Hnd )

UpnpUnRegisterClient unregisters a control point application, unsubscribing all active subscriptions.
+ + +
+

Documentation

+
UpnpUnRegisterClient unregisters a control point application, +unsubscribing all active subscriptions. After this call, the +UpnpClient_Handle is no longer valid. + +

UpnpUnRegisterClient is a synchronous call and generates no +callbacks. The SDK generates no more callbacks after this +function returns. + +

+
Parameters:
Hnd - The handle of the control point instance +to unregister.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpUnRegisterRootDevice.html b/docs/dist/html/upnp/UpnpUnRegisterRootDevice.html new file mode 100644 index 0000000..32ef091 --- /dev/null +++ b/docs/dist/html/upnp/UpnpUnRegisterRootDevice.html @@ -0,0 +1,37 @@ + + + + + EXPORT_SPEC int UpnpUnRegisterRootDevice + + + + +

EXPORT_SPEC int UpnpUnRegisterRootDevice

( IN UpnpDevice_Handle )

Unregisters a root device registered with UpnpRegisterRootDevice or UpnpRegisterRootDevice2.
+ + +
+

Documentation

+
Unregisters a root device registered with UpnpRegisterRootDevice or +UpnpRegisterRootDevice2. After this call, the +UpnpDevice_Handle is no longer valid. For all advertisements that +have not yet expired, the SDK sends a device unavailable message +automatically. + +

UpnpUnRegisterRootDevice is a synchronous call and generates no +callbacks. Once this call returns, the SDK will no longer +generate callbacks to the application. + +

+
Parameters:
- UpnpDevice_Handle The handle of the root device instance to +unregister.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid +device handle. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpUnSubscribe.html b/docs/dist/html/upnp/UpnpUnSubscribe.html new file mode 100644 index 0000000..d1b5ab2 --- /dev/null +++ b/docs/dist/html/upnp/UpnpUnSubscribe.html @@ -0,0 +1,51 @@ + + + + + EXPORT_SPEC int UpnpUnSubscribe + + + + +

EXPORT_SPEC int UpnpUnSubscribe

( IN UpnpClient_Handle Hnd,
  IN Upnp_SID SubsId )

UpnpUnSubscribe removes the subscription of a control point from a service previously subscribed to using UpnpSubscribe or UpnpSubscribeAsync.
+ + +
+

Documentation

+
UpnpUnSubscribe removes the subscription of a control point from a +service previously subscribed to using UpnpSubscribe or +UpnpSubscribeAsync. This is a synchronous call. + +

+
Parameters:
Hnd - The handle of the subscribed control +point. +
SubsId - The ID returned when the control point +subscribed to the service.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_SID: The SubsId is not a valid +subscription ID. +
  • UPNP_E_NETWORK_ERROR: A network error occured. +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket. +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket. +
  • UPNP_E_SOCKET_BIND: An error occurred binding a socket. +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting to +PublisherUrl. +
  • UPNP_E_OUTOF_SOCKET: An error ocurred creating a socket. +
  • UPNP_E_BAD_RESPONSE: An error occurred in response from +the publisher. +
  • UPNP_E_UNSUBSCRIBE_UNACCEPTED: The publisher refused +the unsubscribe request (the client is still unsubscribed and +no longer receives events). +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpUnSubscribeAsync.html b/docs/dist/html/upnp/UpnpUnSubscribeAsync.html new file mode 100644 index 0000000..4e4a82c --- /dev/null +++ b/docs/dist/html/upnp/UpnpUnSubscribeAsync.html @@ -0,0 +1,74 @@ + + + + + EXPORT_SPEC int UpnpUnSubscribeAsync + + + + +

EXPORT_SPEC int UpnpUnSubscribeAsync

( IN UpnpClient_Handle Hnd,
  IN Upnp_SID SubsId,
  IN Upnp_FunPtr Fun,
  IN const void* Cookie )

UpnpUnSubscribeAsync removes a subscription of a control point from a service previously subscribed to using UpnpSubscribe or UpnpSubscribeAsync, generating a callback when the operation is complete.
+ + +
+

Documentation

+
UpnpUnSubscribeAsync removes a subscription of a control +point from a service previously subscribed to using +UpnpSubscribe or UpnpSubscribeAsync, generating a callback +when the operation is complete. + +

Note that many of the error codes for this function are returned in +the Upnp_Event_Subscribe structure. In those cases, the function +returns UPNP_E_SUCCESS and the appropriate error code will +be in the Upnp_Event_Subscribe.ErrCode field in the Event +structure passed to the callback. + +

+
Parameters:
Hnd - The handle of the subscribed control +point. +
SubsId - The ID returned when the +control point subscribed to the service. +
Fun - Pointer to a callback function to be +called when the operation is complete. +
Cookie - Pointer to user data to pass to the +callback function when invoked.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_HANDLE: The handle is not a valid control +point handle. +
  • UPNP_E_INVALID_SID: The SubsId is not a valid SID. +
  • UPNP_E_INVALID_PARAM: Fun is not a valid callback +function pointer. +
  • UPNP_E_OUTOF_MEMORY: Insufficient resources exist to +complete this operation. +
  • UPNP_E_NETWORK_ERROR: A network error occured (returned in +the Upnp_Event_Subscribe.ErrCode field as part of the +callback). +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the callback). +
  • UPNP_E_SOCKET_READ: An error or timeout occurred reading +from a socket (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the +callback). +
  • UPNP_E_SOCKET_BIND: An error occurred binding the socket +(returned in the Upnp_Event_Subscribe.ErrCode field as +part of the callback). +
  • UPNP_E_SOCKET_CONNECT: An error occurred connecting to +PublisherUrl (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the callback). +
  • UPNP_E_OUTOF_SOCKET: An error occurred creating a socket ( +returned in the Upnp_Event_Subscribe.ErrCode field as +part of the callback). +
  • UPNP_E_BAD_RESPONSE: An error occurred in response from +the publisher (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the callback). +
  • UPNP_E_UNSUBSCRIBE_UNACCEPTED: The publisher refused +the subscription request (returned in the +Upnp_Event_Subscribe.ErrCode field as part of the callback). +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpVirtualDirCallbacks.html b/docs/dist/html/upnp/UpnpVirtualDirCallbacks.html new file mode 100644 index 0000000..fc4ee87 --- /dev/null +++ b/docs/dist/html/upnp/UpnpVirtualDirCallbacks.html @@ -0,0 +1,133 @@ + + + + + struct UpnpVirtualDirCallbacks + + + + +

struct UpnpVirtualDirCallbacks

The UpnpVirtualDirCallbacks structure contains the pointers to file-related callback functions a device application can register to virtualize URLs.
+ +
+

+
+[more]int (*close)( IN UpnpWebFileHandle fileHnd ) +
Called by the web server to close a file opened via the open callback. +
+[more]int (*get_info)( IN const char* filename, OUT struct File_Info* info ) +
Called by the web server to query information on a file. +
+[more]UpnpWebFileHandle (*open)( IN const char* filename, IN enum UpnpOpenFileMode Mode ) +
Called by the web server to open a file. +
+[more]int (*read)( IN UpnpWebFileHandle fileHnd, OUT char* buf, IN size_t buflen ) +
Called by the web server to perform a sequential read from an open file. +
+[more]int (*seek)( IN UpnpWebFileHandle fileHnd, IN long offset, IN int origin ) +
Called by the web server to move the file pointer, or offset, into an open file. +
+[more]int (*write)( IN UpnpWebFileHandle fileHnd, IN char* buf, IN size_t buflen ) +
Called by the web server to perform a sequential write to an open file. +

+ + + +
+

Documentation

+
The UpnpVirtualDirCallbacks structure contains the pointers to +file-related callback functions a device application can register to +virtualize URLs.
+
+ + + +
oint (*get_info)( IN const char* filename, OUT struct File_Info* info ) +
Called by the web server to query information on a file. The callback +should return 0 on success or -1 on an error. + +
Parameters:
filename - The name of the file to query. +
info - Pointer to a structure to store the +information on the file.

+ + +

oUpnpWebFileHandle (*open)( IN const char* filename, IN enum UpnpOpenFileMode Mode ) +
Called by the web server to open a file. The callback should return +a valid handle if the file can be opened. Otherwise, it should return +NULL to signify an error. + +
Parameters:
filename - The name of the file to open. +
Mode - The mode in which to open the file. +Valid values are UPNP_READ or +UPNP_WRITE.

+ + +

oint (*read)( IN UpnpWebFileHandle fileHnd, OUT char* buf, IN size_t buflen ) +
Called by the web server to perform a sequential read from an open +file. The callback should copy buflen bytes from the file into +the buffer. + +
Parameters:
fileHnd - The handle of the file to read. +
buf - The buffer in which to place the +data. +
buflen - The size of the buffer (i.e. the +number of bytes to read).
Returns:
[int] An integer representing one of the following: +
    +
  • 0: The file contains no more data (EOF). +
  • >0: A successful read of the number of bytes in the +return code. +
  • <0: An error occurred reading the file. +\end{itemzie} +

+ + +

oint (*write)( IN UpnpWebFileHandle fileHnd, IN char* buf, IN size_t buflen ) +
Called by the web server to perform a sequential write to an open +file. The callback should write buflen bytes into the file from +the buffer. It should return the actual number of bytes written, +which might be less than buflen in the case of a write error. + +
Parameters:
fileHnd - The handle of the file to write. +
buf - The buffer with the bytes to write. +
buflen - The number of bytes to write.

+ + +

oint (*seek)( IN UpnpWebFileHandle fileHnd, IN long offset, IN int origin ) +
Called by the web server to move the file pointer, or offset, into +an open file. The origin parameter determines where to start +moving the file pointer. A value of SEEK_CUR moves the +file pointer relative to where it is. The offset parameter can +be either positive (move forward) or negative (move backward). +SEEK_END moves relative to the end of the file. A positive +offset extends the file. A negative offset moves backward +in the file. Finally, SEEK_SET moves to an absolute position in +the file. In this case, offset must be positive. The callback +should return 0 on a successful seek or a non-zero value on an error. + +
Parameters:
fileHnd - The handle of the file to move the +file pointer. +
offset - The number of bytes to move in the +file. Positive values move foward and +negative values move backward. Note +that this must be positive if the +origin is SEEK_SET. +
origin - The position to move relative to. It +can be SEEK_CUR to move relative +to the current position, +SEEK_END to move relative to +the end of the file, or +SEEK_SET to specify an absolute +offset.

+ + +

oint (*close)( IN UpnpWebFileHandle fileHnd ) +
Called by the web server to close a file opened via the open +callback. It should return 0 on success, or a non-zero value on an +error. + +
Parameters:
fileHnd - The handle of the file to close.

+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/UpnpWriteHttpPost.html b/docs/dist/html/upnp/UpnpWriteHttpPost.html new file mode 100644 index 0000000..d50b38a --- /dev/null +++ b/docs/dist/html/upnp/UpnpWriteHttpPost.html @@ -0,0 +1,40 @@ + + + + + EXPORT_SPEC int UpnpWriteHttpPost + + + + +

EXPORT_SPEC int UpnpWriteHttpPost

( IN void* handle,
  IN char* buf,
  IN unsigned int* size,
  IN int timeout )

UpnpWriteHttpPost sends a request to a server to copy the contents of a buffer to the URI specified in the UpnpOpenHttpPost call.
+ + +
+

Documentation

+
UpnpWriteHttpPost sends a request to a server to copy the contents of +a buffer to the URI specified in the UpnpOpenHttpPost call. + +

+
Parameters:
handle - The handle of the connection created +by the call to UpnpOpenHttpPost. +
buf - The buffer to be posted. +
size - The size, in bytes of buf. +
timeout - A timeout value sent with the request +during which a response is expected +from the server, failing which, an +error is reported.
Returns:
[int] An integer representing one of the following: +
    +
  • UPNP_E_SUCCESS: The operation completed successfully. +
  • UPNP_E_INVALID_PARAM: Either handle, buf +or size is not a valid pointer. +
  • UPNP_E_SOCKET_WRITE: An error or timeout occurred writing +to a socket. +
  • UPNP_E_OUTOF_SOCKET: Too many sockets are currently +allocated. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Upnp_Action_Request.html b/docs/dist/html/upnp/Upnp_Action_Request.html new file mode 100644 index 0000000..62a0170 --- /dev/null +++ b/docs/dist/html/upnp/Upnp_Action_Request.html @@ -0,0 +1,108 @@ + + + + + struct Upnp_Action_Request + + + + +

struct Upnp_Action_Request

Returned as part of a UPNP_CONTROL_ACTION_COMPLETE callback.
+ +
+

+
+[more]char ActionName[NAME_SIZE] +
The Action Name. +
+[more]IXML_Document* ActionRequest +
The DOM document describing the action. +
+[more]IXML_Document* ActionResult +
The DOM document describing the result of the action. +
+[more]struct in_addr CtrlPtIPAddr +
IP address of the control point requesting this action. +
+[more]char DevUDN[NAME_SIZE] +
The unique device ID. +
+[more]int ErrCode +
The result of the operation. +
+[more]char ErrStr[LINE_SIZE] +
The error string in case of error. +
+[more]char ServiceID[NAME_SIZE] +
The service ID. +
+[more]IXML_Document* SoapHeader +
The DOM document containing the information from the the SOAP header. +
+[more]int Socket +
The socket number of the connection to the requestor. +

+ + + +
+

Documentation

+
Returned as part of a UPNP_CONTROL_ACTION_COMPLETE callback.
+
+ + + +
oint ErrCode +
The result of the operation. +

+ + +

oint Socket +
The socket number of the connection to the requestor. +

+ + +

ochar ErrStr[LINE_SIZE] +
The error string in case of error. +

+ + +

ochar ActionName[NAME_SIZE] +
The Action Name. +

+ + +

ochar DevUDN[NAME_SIZE] +
The unique device ID. +

+ + +

ochar ServiceID[NAME_SIZE] +
The service ID. +

+ + +

oIXML_Document* ActionRequest +
The DOM document describing the action. +

+ + +

oIXML_Document* ActionResult +
The DOM document describing the result of the action. +

+ + +

ostruct in_addr CtrlPtIPAddr +
IP address of the control point requesting this action. +

+ + +

oIXML_Document* SoapHeader +
The DOM document containing the information from the +the SOAP header. +

+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Upnp_DescType.html b/docs/dist/html/upnp/Upnp_DescType.html new file mode 100644 index 0000000..7a2bb16 --- /dev/null +++ b/docs/dist/html/upnp/Upnp_DescType.html @@ -0,0 +1,34 @@ + + + + + enum Upnp_DescType + + + + +

enum Upnp_DescType

Specifies the type of description in UpnpRegisterRootDevice2.
+ +
These values control how UpnpRegisterRootDevice2 +interprets the description parameter.
+ +
+
+
+ +o +UPNPREG_URL_DESC
The description is the URL to the description document. +
+ +o +UPNPREG_FILENAME_DESC
The description is a file name on the local file system containing the description of the device. +
+ +o +UPNPREG_BUF_DESC
The description is a pointer to a character array containing the XML description document. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Upnp_Discovery.html b/docs/dist/html/upnp/Upnp_Discovery.html new file mode 100644 index 0000000..cb086e1 --- /dev/null +++ b/docs/dist/html/upnp/Upnp_Discovery.html @@ -0,0 +1,115 @@ + + + + + struct Upnp_Discovery + + + + +

struct Upnp_Discovery

Returned in a UPNP_DISCOVERY_RESULT callback.
+ +
+

+
+[more]char Date[LINE_SIZE] +
Date when the response was generated. +
+[more]SOCKADDRIN* DestAddr +
The host address of the device responding to the search. +
+[more]char DeviceId[LINE_SIZE] +
The unique device identifier. +
+[more]char DeviceType[LINE_SIZE] +
The device type. +
+[more]int ErrCode +
The result code of the UpnpSearchAsync call. +
+[more]int Expires +
The expiration time of the advertisement. +
+[more]char Ext[LINE_SIZE] +
Confirmation that the MAN header was understood by the device. +
+[more]char Location[LINE_SIZE] +
The URL to the UPnP description document for the device. +
+[more]char Os[LINE_SIZE] +
The operating system the device is running. +
+[more]char ServiceType[LINE_SIZE] +
The service type. +
+[more]char ServiceVer[LINE_SIZE] +
The service version. +

+ + + +
+

Documentation

+
Returned in a UPNP_DISCOVERY_RESULT callback.
+
+ + + +
oint ErrCode +
The result code of the UpnpSearchAsync call. +

+ + +

oint Expires +
The expiration time of the advertisement. +

+ + +

ochar DeviceId[LINE_SIZE] +
The unique device identifier. +

+ + +

ochar DeviceType[LINE_SIZE] +
The device type. +

+ + +

ochar ServiceType[LINE_SIZE] +
The service type. +

+ + +

ochar ServiceVer[LINE_SIZE] +
The service version. +

+ + +

ochar Location[LINE_SIZE] +
The URL to the UPnP description document for the device. +

+ + +

ochar Os[LINE_SIZE] +
The operating system the device is running. +

+ + +

ochar Date[LINE_SIZE] +
Date when the response was generated. +

+ + +

ochar Ext[LINE_SIZE] +
Confirmation that the MAN header was understood by the device. +

+ + +

oSOCKADDRIN* DestAddr +
The host address of the device responding to the search. +

+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Upnp_Event.html b/docs/dist/html/upnp/Upnp_Event.html new file mode 100644 index 0000000..ae3072a --- /dev/null +++ b/docs/dist/html/upnp/Upnp_Event.html @@ -0,0 +1,51 @@ + + + + + struct Upnp_Event + + + + +

struct Upnp_Event

Returned along with a UPNP_EVENT_RECEIVED callback.
+ +
+

+
+[more]IXML_Document* ChangedVariables +
The DOM tree representing the changes generating the event. +
+[more]int EventKey +
The event sequence number. +
+[more]Upnp_SID Sid +
The subscription ID for this subscription. +

+ + + +
+

Documentation

+
Returned along with a UPNP_EVENT_RECEIVED callback.
+
+ + + +
oUpnp_SID Sid +
The subscription ID for this subscription. +

+ + +

oint EventKey +
The event sequence number. +

+ + +

oIXML_Document* ChangedVariables +
The DOM tree representing the changes generating the event. +

+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Upnp_Event_Subscribe.html b/docs/dist/html/upnp/Upnp_Event_Subscribe.html new file mode 100644 index 0000000..88f3d6a --- /dev/null +++ b/docs/dist/html/upnp/Upnp_Event_Subscribe.html @@ -0,0 +1,64 @@ + + + + + struct Upnp_Event_Subscribe + + + + +

struct Upnp_Event_Subscribe

Returned along with a UPNP_EVENT_SUBSCRIBE_COMPLETE or UPNP_EVENT_UNSUBSCRIBE_COMPLETE callback.
+ +
+

+
+[more]int ErrCode +
The result of the operation. +
+[more]char PublisherUrl[NAME_SIZE] +
The event URL being subscribed to or removed from. +
+[more]Upnp_SID Sid +
The SID for this subscription. +
+[more]int TimeOut +
The actual subscription time (for subscriptions only). +

+ + + +
+

Documentation

+
Returned along with a UPNP_EVENT_SUBSCRIBE_COMPLETE or +UPNP_EVENT_UNSUBSCRIBE_COMPLETE callback.
+
+ + + +
oUpnp_SID Sid +
The SID for this subscription. For subscriptions, this only +contains a valid SID if the Upnp_EventSubscribe.result field +contains a UPNP_E_SUCCESS result code. For unsubscriptions, +this contains the SID from which the subscription is being +unsubscribed. +

+ + +

oint ErrCode +
The result of the operation. +

+ + +

ochar PublisherUrl[NAME_SIZE] +
The event URL being subscribed to or removed from. +

+ + +

oint TimeOut +
The actual subscription time (for subscriptions only). +

+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Upnp_FunPtr.html b/docs/dist/html/upnp/Upnp_FunPtr.html new file mode 100644 index 0000000..06e7892 --- /dev/null +++ b/docs/dist/html/upnp/Upnp_FunPtr.html @@ -0,0 +1,42 @@ + + + + + typedef int (*Upnp_FunPtr) + + + + +

typedef int (*Upnp_FunPtr)

( IN Upnp_EventType EventType,
  IN void* Event, IN void* Cookie )

All callback functions share the same prototype, documented below.
+ + +
+

Documentation

+
All callback functions share the same prototype, documented below. +Note that any memory passed to the callback function +is valid only during the callback and should be copied if it +needs to persist. This callback function needs to be thread +safe. The context of the callback is always on a valid thread +context and standard synchronization methods can be used. Note, +however, because of this the callback cannot call SDK functions +unless explicitly noted. + +

+      int CallbackFxn( Upnp_EventType EventType, void* Event, void* Cookie );
+    
+ +

where EventType is the event that triggered the callback, +Event is a structure that denotes event-specific information for that +event, and Cookie is the user data passed when the callback was +registered. + +

See Upnp_EventType for more information on the callback values and +the associated Event parameter. + +

The return value of the callback is currently ignored. It may be used +in the future to communicate results back to the SDK.

+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Upnp_SID44.html b/docs/dist/html/upnp/Upnp_SID44.html new file mode 100644 index 0000000..cf87bf0 --- /dev/null +++ b/docs/dist/html/upnp/Upnp_SID44.html @@ -0,0 +1,22 @@ + + + + + typedef char Upnp_SID[44] + + + + +

typedef char Upnp_SID[44]

The Upnp_SID holds the subscription identifier for a subscription between a client and a device.
+ + +
+

Documentation

+
The Upnp_SID holds the subscription identifier for a subscription +between a client and a device. The SID is a string representation of +a globally unique id (GUID) and should not be modified.
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Upnp_SType.html b/docs/dist/html/upnp/Upnp_SType.html new file mode 100644 index 0000000..1a8623a --- /dev/null +++ b/docs/dist/html/upnp/Upnp_SType.html @@ -0,0 +1,40 @@ + + + + + enum Upnp_SType + + + + +

enum Upnp_SType

Represents the different types of searches that can be performed using the SDK for UPnP Devices API.
+ +
By specifying these different values to +UpnpSearchAsync, the control point application +can control the scope of the search from all devices +to specific devices or services.
+ +
+
+
+ +o +UPNP_S_ALL
Search for all devices and services on the network. +
+ +o +UPNP_S_ROOT
Search for all root devices on the network. +
+ +o +UPNP_S_DEVICE
Search for a particular device type or a particular device instance. +
+ +o +UPNP_S_SERVICE
Search for a particular service type, possibly on a particular device type or device instance. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Upnp_State_Var_Complete.html b/docs/dist/html/upnp/Upnp_State_Var_Complete.html new file mode 100644 index 0000000..ca9ebfe --- /dev/null +++ b/docs/dist/html/upnp/Upnp_State_Var_Complete.html @@ -0,0 +1,60 @@ + + + + + struct Upnp_State_Var_Complete + + + + +

struct Upnp_State_Var_Complete

Represents the reply for the current value of a state variable in an asynchronous call.
+ +
+

+
+[more]char CtrlUrl[NAME_SIZE] +
The control URL for the service. +
+[more]DOMString CurrentVal +
The current value of the variable or error string in case of error. +
+[more]int ErrCode +
The result of the operation. +
+[more]char StateVarName[NAME_SIZE] +
The name of the variable. +

+ + + +
+

Documentation

+
Represents the reply for the current value of a state variable in an +asynchronous call.
+
+ + + +
oint ErrCode +
The result of the operation. +

+ + +

ochar CtrlUrl[NAME_SIZE] +
The control URL for the service. +

+ + +

ochar StateVarName[NAME_SIZE] +
The name of the variable. +

+ + +

oDOMString CurrentVal +
The current value of the variable or error string in case of error. +

+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Upnp_State_Var_Request.html b/docs/dist/html/upnp/Upnp_State_Var_Request.html new file mode 100644 index 0000000..98ca6e1 --- /dev/null +++ b/docs/dist/html/upnp/Upnp_State_Var_Request.html @@ -0,0 +1,93 @@ + + + + + struct Upnp_State_Var_Request + + + + +

struct Upnp_State_Var_Request

Represents the request for current value of a state variable in a service state table.
+ +
+

+
+[more]struct in_addr CtrlPtIPAddr +
IP address of sender requesting the state variable. +
+[more]DOMString CurrentVal +
The current value of the variable. +
+[more]char DevUDN[NAME_SIZE] +
The unique device ID. +
+[more]int ErrCode +
The result of the operation. +
+[more]char ErrStr[LINE_SIZE] +
The error string in case of error. +
+[more]char ServiceID[NAME_SIZE] +
The service ID. +
+[more]int Socket +
The socket number of the connection to the requestor. +
+[more]char StateVarName[NAME_SIZE] +
The name of the variable. +

+ + + +
+

Documentation

+
Represents the request for current value of a state variable in a service +state table.
+
+ + + +
oint ErrCode +
The result of the operation. +

+ + +

oint Socket +
The socket number of the connection to the requestor. +

+ + +

ochar ErrStr[LINE_SIZE] +
The error string in case of error. +

+ + +

ochar DevUDN[NAME_SIZE] +
The unique device ID. +

+ + +

ochar ServiceID[NAME_SIZE] +
The service ID. +

+ + +

ochar StateVarName[NAME_SIZE] +
The name of the variable. +

+ + +

ostruct in_addr CtrlPtIPAddr +
IP address of sender requesting the state variable. +

+ + +

oDOMString CurrentVal +
The current value of the variable. This needs to be allocated by +the caller. When finished with it, the SDK frees this DOMString. +

+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/Upnp_Subscription_Request.html b/docs/dist/html/upnp/Upnp_Subscription_Request.html new file mode 100644 index 0000000..0f6dc56 --- /dev/null +++ b/docs/dist/html/upnp/Upnp_Subscription_Request.html @@ -0,0 +1,52 @@ + + + + + struct Upnp_Subscription_Request + + + + +

struct Upnp_Subscription_Request

Returned along with a UPNP_EVENT_SUBSCRIPTION_REQUEST callback.
+ +
+

+
+[more]char* ServiceId +
The identifier for the service being subscribed to. +
+[more]Upnp_SID Sid +
The assigned subscription ID for this subscription. +
+[more]char* UDN +
Universal device name. +

+ + + +
+

Documentation

+
Returned along with a UPNP_EVENT_SUBSCRIPTION_REQUEST +callback.
+
+ + + +
ochar* ServiceId +
The identifier for the service being subscribed to. +

+ + +

ochar* UDN +
Universal device name. +

+ + +

oUpnp_SID Sid +
The assigned subscription ID for this subscription. +

+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/WebServerAPI.html b/docs/dist/html/upnp/WebServerAPI.html new file mode 100644 index 0000000..89e337a --- /dev/null +++ b/docs/dist/html/upnp/WebServerAPI.html @@ -0,0 +1,47 @@ + + + + + Web Server API + + + + +

Web Server API

+ +
+
+
+ +o +UpnpSetWebServerRootDir
UpnpSetWebServerRootDir sets the document root directory for the internal web server. +
+ +o +UpnpSetVirtualDirCallbacks
UpnpSetVirtualDirCallbacks sets the callback function to be used to access a virtual directory. +
+ +o +UpnpEnableWebserver
UpnpEnableWebServer enables or disables the webserver. +
+ +o +UpnpIsWebserverEnabled
UpnpIsWebServerEnabled returns TRUE if the webserver is enabled, or FALSE if it is not. +
+ +o +UpnpAddVirtualDir
UpnpAddVirtualDir adds a virtual directory mapping. +
+ +o +UpnpRemoveVirtualDir
UpnpRemoveVirtualDir removes a virtual directory mapping made with UpnpAddVirtualDir. +
+ +o +UpnpRemoveAllVirtualDirs
UpnpRemoveAllVirtualDirs removes all virtual directory mappings. +
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/icon1.gif b/docs/dist/html/upnp/icon1.gif new file mode 100644 index 0000000..f78f30e Binary files /dev/null and b/docs/dist/html/upnp/icon1.gif differ diff --git a/docs/dist/html/upnp/icon2.gif b/docs/dist/html/upnp/icon2.gif new file mode 100644 index 0000000..6cbe01a Binary files /dev/null and b/docs/dist/html/upnp/icon2.gif differ diff --git a/docs/dist/html/upnp/index.html b/docs/dist/html/upnp/index.html new file mode 100644 index 0000000..53153cb --- /dev/null +++ b/docs/dist/html/upnp/index.html @@ -0,0 +1,42 @@ + + + + + Linux SDK for UPnP Devices v1.4 + + + + +

Linux SDK for UPnP Devices v1.4

+
+
+Linux SDK for UPnP Devices Version 1.4 + +

Copyright (C) 2000-2003 Intel Corporation ALL RIGHTS RESERVED + +

Revision 1.4.1 (Tue 04 Jul 2006 04:58:36 PM EEST) +

+ +
+
+
+ +o +Introduction
+ +o +License
+ +o +About Callbacks
+ +o +The API
+ +o +Optional Tool APIs
+

Alphabetic index

+
+This page was generated with the help of DOC++. + + diff --git a/docs/dist/html/upnp/toc.html b/docs/dist/html/upnp/toc.html new file mode 100644 index 0000000..c43f1ca --- /dev/null +++ b/docs/dist/html/upnp/toc.html @@ -0,0 +1,19 @@ + + + + + Table of Contents + + + + +

Table of Contents

+

General stuff

+ +
+
+This page was generated with the help of DOC++. + + diff --git a/threadutil/inc/ThreadPool.h b/threadutil/inc/ThreadPool.h index 3ef79e7..c8ae478 100644 --- a/threadutil/inc/ThreadPool.h +++ b/threadutil/inc/ThreadPool.h @@ -67,6 +67,10 @@ typedef enum priority {LOW_PRIORITY, //Statistics +#ifdef WIN32 // todo: check why STATSONLY fails during compilation + #undef STATS +#endif + #ifdef STATS #define STATSONLY(x) x #else diff --git a/upnp/doc/Makefile.am b/upnp/doc/Makefile.am index 2959268..7b6c743 100644 --- a/upnp/doc/Makefile.am +++ b/upnp/doc/Makefile.am @@ -35,16 +35,9 @@ # ########################################################################## -EXTRA_DIST = UPnP_Programming_Guide.pdf \ - callback.dxx docxx.sty intro.dxx \ +EXTRA_DIST = callback.dxx docxx.sty intro.dxx \ license.dxx upnpsdk.dxx -if WITH_DOCDIR - docdir = @DOCDIR@ - doc_DATA = UPnP_Programming_Guide.pdf -endif - - html-local: @if [ -d html ]; then rm -rf html; fi @doc++ -nd -S -w -j -d html $(srcdir)/upnpsdk.dxx diff --git a/upnp/doc/upnpsdk.dxx b/upnp/doc/upnpsdk.dxx index cb46c57..0690436 100644 --- a/upnp/doc/upnpsdk.dxx +++ b/upnp/doc/upnpsdk.dxx @@ -1,11 +1,11 @@ -/**@name Linux SDK for UPnP Devices v1.2 +/**@name Linux SDK for UPnP Devices v1.4 * *\begin{center} - * {\bf Linux SDK for UPnP Devices Version 1.2} + * {\bf Linux SDK for UPnP Devices Version 1.4} * * Copyright (C) 2000-2003 Intel Corporation ALL RIGHTS RESERVED * - * Revision 1.2.1 (\Date) + * Revision 1.4.1 (\Date) *\end{center} */ //@{ diff --git a/upnp/src/genlib/net/http/httpparser.c b/upnp/src/genlib/net/http/httpparser.c index cfb7210..a13d51b 100644 --- a/upnp/src/genlib/net/http/httpparser.c +++ b/upnp/src/genlib/net/http/httpparser.c @@ -973,21 +973,21 @@ skip_to_end_of_header( INOUT scanner_t * scanner ) } /************************************************************************ -* Function: match_char -* -* Parameters: -* INOUT scanner_t* scanner ; Scanner Object -* IN char c ; Character to be compared with -* IN xboolean case_sensitive; Flag indicating whether comparison should +* Function: match_char +* +* Parameters: +* INOUT scanner_t* scanner ; Scanner Object +* IN char c ; Character to be compared with +* IN xboolean case_sensitive; Flag indicating whether comparison should * be case sensitive -* -* Description: Compares a character to the next char in the scanner; -* on error, scanner chars are not restored -* -* Returns: -* PARSE_OK -* PARSE_NO_MATCH -* PARSE_INCOMPLETE +* +* Description: Compares a character to the next char in the scanner; +* on error, scanner chars are not restored +* +* Returns: +* PARSE_OK +* PARSE_NO_MATCH +* PARSE_INCOMPLETE ************************************************************************/ static XINLINE parse_status_t match_char( INOUT scanner_t * scanner, diff --git a/upnp/src/genlib/net/http/webserver.c b/upnp/src/genlib/net/http/webserver.c index 6c0a1af..0155a94 100644 --- a/upnp/src/genlib/net/http/webserver.c +++ b/upnp/src/genlib/net/http/webserver.c @@ -751,15 +751,15 @@ isFileInVirtualDir( IN char *filePath ) } /************************************************************************ -* Function: ToUpperCase -* -* Parameters: -* INOUT char * Str ; Input string to be converted -* -* Description: Converts input string to upper case -* -* Returns: -* int +* Function: ToUpperCase +* +* Parameters: +* INOUT char * Str ; Input string to be converted +* +* Description: Converts input string to upper case +* +* Returns: +* int ************************************************************************/ int ToUpperCase( char *Str ) @@ -773,15 +773,15 @@ ToUpperCase( char *Str ) } /************************************************************************ -* Function: StrStr -* -* Parameters: +* Function: StrStr +* +* Parameters: * IN char * S1 ; Input string -* IN char * S2 ; Input sub-string -* -* Description: Finds a substring from a string -* -* Returns: +* IN char * S2 ; Input sub-string +* +* Description: Finds a substring from a string +* +* Returns: * char * ptr - pointer to the first occurence of S2 in S1 ************************************************************************/ char * diff --git a/upnp/src/inc/inet_pton.h b/upnp/src/inc/inet_pton.h index 60fa16b..df59b6d 100644 --- a/upnp/src/inc/inet_pton.h +++ b/upnp/src/inc/inet_pton.h @@ -51,7 +51,7 @@ extern const char * inet_ntop6(src, dst, size); * author: * Paul Vixie, 1996. */ -extern int inet_pton4(src, dst); +extern inet_pton4(const char *src,u_char *dst); /* int * inet_pton6(src, dst) @@ -83,7 +83,7 @@ extern int inet_pton6(src, dst); * author: * Paul Vixie, 1996. */ -extern const char * inet_ntop(af, src, dst, size); +extern const char *inet_ntop(int af,const void *src,char *dst,socklen_t size); /* int @@ -97,7 +97,7 @@ extern const char * inet_ntop(af, src, dst, size); * author: * Paul Vixie, 1996. */ -extern int inet_pton(af, src, dst); +extern int inet_pton(int af,const char *src,void *dst); #endif #endif diff --git a/upnp/src/inet_pton.c b/upnp/src/inet_pton.c index b46c354..d43382e 100644 --- a/upnp/src/inet_pton.c +++ b/upnp/src/inet_pton.c @@ -73,7 +73,7 @@ inet_ntop4(const u_char *src, char *dst, socklen_t size) } tmp[i - 1] = '\0'; - if (strlen(tmp)>size) { + if ((socklen_t)strlen(tmp)>size) { //__set_errno (ENOSPC); return (NULL); } @@ -193,9 +193,7 @@ inet_ntop6(src, dst, size) * Paul Vixie, 1996. */ static int -inet_pton4(src, dst) - const char *src; - u_char *dst; +inet_pton4(const char *src,u_char *dst) { int saw_digit, octets, ch; u_char tmp[4], *tp; @@ -345,12 +343,7 @@ inet_pton6(src, dst) * author: * Paul Vixie, 1996. */ -extern const char * -inet_ntop(af, src, dst, size) - int af; - const void *src; - char *dst; - socklen_t size; +extern const char *inet_ntop(int af,const void *src,char *dst,socklen_t size) { switch (af) { case AF_INET: @@ -378,11 +371,7 @@ inet_ntop(af, src, dst, size) * author: * Paul Vixie, 1996. */ -extern int -inet_pton(af, src, dst) - int af; - const char *src; - void *dst; +int inet_pton(int af,const char *src,void *dst) { switch (af) { case AF_INET: diff --git a/upnp/src/soap/soap_device.c b/upnp/src/soap/soap_device.c index bcb0176..f7dc8e7 100644 --- a/upnp/src/soap/soap_device.c +++ b/upnp/src/soap/soap_device.c @@ -34,7 +34,7 @@ #if EXCLUDE_SOAP == 0 #define SOAP_BODY "Body" -#define SOAP_URN "http://schemas.xmlsoap.org/soap/envelope/" +#define SOAP_URN "http:/""/schemas.xmlsoap.org/soap/envelope/" #define QUERY_STATE_VAR_URN "urn:schemas-upnp-org:control-1-0"