|
UPnPsdk 0.1
Universal Plug and Play +, Software Development Kit
|
|
| |
|
UPnPsdk 0.1
Universal Plug and Play +, Software Development Kit
|
|
|
| |
Definition of the UPNP_E_* error messages. More...
This graph shows which files directly or indirectly include this file:Go to the source code of this file.
Macros | |
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. | |
| #define | UPNP_E_SUCCESS 0 |
| The operation completed successfully. | |
| #define | UPNP_E_INVALID_HANDLE -100 |
| The handle passed to a function is not a recognized as a valid handle. | |
| #define | UPNP_E_INVALID_PARAM -101 |
| One or more of the parameters passed to the function is not valid. | |
| #define | UPNP_E_OUTOF_HANDLE -102 |
| The SDK does not have any more space for additional handles. | |
| #define | UPNP_E_OUTOF_MEMORY -104 |
| Not enough resources are currently available to complete the operation. | |
| #define | UPNP_E_INIT -105 |
| The SDK has already been initialized. | |
| #define | UPNP_E_INVALID_DESC -107 |
| The description document passed to UpnpRegisterRootDevice, UpnpRegisterRootDevice2 UpnpRegisterRootDevice3 or UpnpRegisterRootDevice4 is invalid. | |
| #define | UPNP_E_INVALID_URL -108 |
| An URL passed into the function is invalid. | |
| #define | UPNP_E_INVALID_SERVICE -111 |
| The device ID/service ID pair does not refer to a valid service. | |
| #define | UPNP_E_BAD_RESPONSE -113 |
| The response received from the remote side of a connection is not correct for the protocol. | |
| #define | UPNP_E_INVALID_ACTION -115 |
| The SOAP action message is invalid. | |
| #define | UPNP_E_FINISH -116 |
| UpnpInit2 has not been called, or UpnpFinish has already been called. | |
| #define | UPNP_E_INIT_FAILED -117 |
| UpnpInit2 cannot complete. | |
| #define | UPNP_E_URL_TOO_BIG -118 |
| The URL passed into a function is too long. | |
| #define | UPNP_E_BAD_HTTPMSG -119 |
| The HTTP message contains invalid message headers. | |
| #define | UPNP_E_ALREADY_REGISTERED -120 |
| A client or a device is already registered. | |
| #define | UPNP_E_INVALID_INTERFACE -121 |
| The interface provided to UpnpInit2 is unknown or does not have a valid IPv4 or IPv6 address configured. | |
| #define | UPNP_E_NETWORK_ERROR -200 |
| A network error occurred. | |
| #define | UPNP_E_SOCKET_WRITE -201 |
| An error happened while writing to a socket. | |
| #define | UPNP_E_SOCKET_READ -202 |
| An error happened while reading from a socket. | |
| #define | UPNP_E_SOCKET_BIND -203 |
| The SDK had a problem binding a socket to a network interface. | |
| #define | UPNP_E_SOCKET_CONNECT -204 |
| The SDK had a problem connecting to a remote host. | |
| #define | UPNP_E_OUTOF_SOCKET -205 |
| The SDK cannot create any more sockets. | |
| #define | UPNP_E_LISTEN -206 |
| The SDK had a problem setting the socket to listen for incoming connections. | |
| #define | UPNP_E_TIMEDOUT -207 |
| Too much time elapsed before the required number of bytes were sent or received over a socket. | |
| #define | UPNP_E_SOCKET_ERROR -208 |
| Generic socket error code for conditions not covered by other error codes. | |
| #define | UPNP_E_CANCELED -210 |
| The operation was canceled. | |
| #define | UPNP_E_SOCKET_ACCEPT -211 |
| The SDK had a problem accepting a network connection. | |
| #define | UPNP_E_SUBSCRIBE_UNACCEPTED -301 |
| A subscription request was rejected from the remote side. | |
| #define | UPNP_E_UNSUBSCRIBE_UNACCEPTED -302 |
| An unsubscribe request was rejected from the remote side. | |
| #define | UPNP_E_NOTIFY_UNACCEPTED -303 |
| The remote host did not accept the notify sent from the local device. | |
| #define | UPNP_E_INVALID_ARGUMENT -501 |
| One or more of the parameters passed to a function is invalid. | |
| #define | UPNP_E_FILE_NOT_FOUND -502 |
| The filename passed to one of the device registration functions was not found or was not accessible. | |
| #define | UPNP_E_FILE_READ_ERROR -503 |
| An error happened while reading a file. | |
| #define | UPNP_E_EXT_NOT_XML -504 |
| The file name of the description document passed to UpnpRegisterRootDevice2 does not end in ".xml". | |
| #define | UPNP_E_NOT_FOUND -507 |
| The response to a SOAP request did not contain the required XML constructs. | |
| #define | UPNP_E_INTERNAL_ERROR -911 |
| Generic error code for internal conditions not covered by other error codes. | |
Definition of the UPNP_E_* error messages.
Definition in file messages.hpp.
| #define UPNP_E_SUCCESS 0 |
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.
Definition at line 27 of file messages.hpp.
| #define UPNP_E_INVALID_HANDLE -100 |
The handle passed to a function is not a recognized as a valid handle.
Definition at line 32 of file messages.hpp.
| #define UPNP_E_INVALID_PARAM -101 |
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.
Definition at line 40 of file messages.hpp.
| #define UPNP_E_OUTOF_HANDLE -102 |
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.
Definition at line 47 of file messages.hpp.
| #define UPNP_E_OUTOF_MEMORY -104 |
Not enough resources are currently available to complete the operation.
Most operations require some free memory in order to complete their work.
Definition at line 57 of file messages.hpp.
| #define UPNP_E_INIT -105 |
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.
Definition at line 65 of file messages.hpp.
| #define UPNP_E_INVALID_DESC -107 |
The description document passed to UpnpRegisterRootDevice, UpnpRegisterRootDevice2 UpnpRegisterRootDevice3 or UpnpRegisterRootDevice4 is invalid.
Definition at line 74 of file messages.hpp.
| #define UPNP_E_INVALID_URL -108 |
An 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.
Definition at line 83 of file messages.hpp.
| #define UPNP_E_INVALID_SERVICE -111 |
The device ID/service ID pair does not refer to a valid service.
Returned only by UpnpNotify, UpnpNotifyExt, UpnpAcceptSubscription, and UpnpAcceptSubscriptionExt.
Definition at line 95 of file messages.hpp.
| #define UPNP_E_BAD_RESPONSE -113 |
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.
Definition at line 103 of file messages.hpp.
| #define UPNP_E_INVALID_ACTION -115 |
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.
Definition at line 113 of file messages.hpp.
| #define UPNP_E_FINISH -116 |
UpnpInit2 has not been called, or UpnpFinish has already been called.
None of the API functions operate until UpnpInit2 successfully completes.
Definition at line 121 of file messages.hpp.
| #define UPNP_E_INIT_FAILED -117 |
UpnpInit2 cannot complete.
The typical reason is failure to allocate sufficient resources.
Definition at line 128 of file messages.hpp.
| #define UPNP_E_URL_TOO_BIG -118 |
The URL passed into a function is too long.
The SDK limits URLs to 180 characters in length.
Definition at line 135 of file messages.hpp.
| #define UPNP_E_BAD_HTTPMSG -119 |
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).
Definition at line 146 of file messages.hpp.
| #define UPNP_E_ALREADY_REGISTERED -120 |
A client or a device is already registered.
The SDK currently has a limit of one registered client and one registered device per process.
Definition at line 154 of file messages.hpp.
| #define UPNP_E_INVALID_INTERFACE -121 |
The interface provided to UpnpInit2 is unknown or does not have a valid IPv4 or IPv6 address configured.
Definition at line 160 of file messages.hpp.
| #define UPNP_E_NETWORK_ERROR -200 |
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.
Definition at line 169 of file messages.hpp.
| #define UPNP_E_SOCKET_WRITE -201 |
An error happened while 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).
Definition at line 179 of file messages.hpp.
| #define UPNP_E_SOCKET_READ -202 |
An error happened while 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).
Definition at line 189 of file messages.hpp.
| #define UPNP_E_SOCKET_BIND -203 |
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).
Definition at line 199 of file messages.hpp.
| #define UPNP_E_SOCKET_CONNECT -204 |
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).
Definition at line 209 of file messages.hpp.
| #define UPNP_E_OUTOF_SOCKET -205 |
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).
Definition at line 219 of file messages.hpp.
| #define UPNP_E_LISTEN -206 |
The SDK had a problem setting the socket to listen for incoming connections.
This error only happens during initialization (i.e. UpnpInit2).
Definition at line 227 of file messages.hpp.
| #define UPNP_E_TIMEDOUT -207 |
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.
Definition at line 235 of file messages.hpp.
| #define UPNP_E_SOCKET_ERROR -208 |
Generic socket error code for conditions not covered by other error codes.
This error can be returned by any function that performs network operations.
Definition at line 243 of file messages.hpp.
| #define UPNP_E_CANCELED -210 |
The operation was canceled.
This error can be returned by any function that allows for external cancelation.
Definition at line 252 of file messages.hpp.
| #define UPNP_E_SOCKET_ACCEPT -211 |
The SDK had a problem accepting a network connection.
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).
Definition at line 262 of file messages.hpp.
| #define UPNP_E_SUBSCRIBE_UNACCEPTED -301 |
A subscription request was rejected from the remote side.
Definition at line 269 of file messages.hpp.
| #define UPNP_E_UNSUBSCRIBE_UNACCEPTED -302 |
An unsubscribe request was rejected from the remote side.
Definition at line 274 of file messages.hpp.
| #define UPNP_E_NOTIFY_UNACCEPTED -303 |
The remote host did not accept the notify sent from the local device.
Definition at line 279 of file messages.hpp.
| #define UPNP_E_INVALID_ARGUMENT -501 |
One or more of the parameters passed to a function is invalid.
Refer to the individual function descriptions for the acceptable ranges for parameters.
Definition at line 287 of file messages.hpp.
| #define UPNP_E_FILE_NOT_FOUND -502 |
The filename passed to one of the device registration functions was not found or was not accessible.
Definition at line 293 of file messages.hpp.
| #define UPNP_E_FILE_READ_ERROR -503 |
An error happened while reading a file.
Definition at line 298 of file messages.hpp.
| #define UPNP_E_EXT_NOT_XML -504 |
The file name of the description document passed to UpnpRegisterRootDevice2 does not end in ".xml".
Definition at line 304 of file messages.hpp.
| #define UPNP_E_NOT_FOUND -507 |
The response to a SOAP request did not contain the required XML constructs.
Definition at line 313 of file messages.hpp.
| #define UPNP_E_INTERNAL_ERROR -911 |
Generic error code for internal conditions not covered by other error codes.
Definition at line 319 of file messages.hpp.
1.9.8 