:orphan:

.. index:: pair: group; Test API for DLNA UPnP commons
.. _doxid-group__tapi__upnp__common:

Test API for DLNA UPnP commons
==============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Definition of Test API DLNA UPnP commons. :ref:`More...<details-group__tapi__upnp__common>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// global functions

	char* :ref:`tapi_upnp_get_st_uuid<doxid-group__tapi__upnp__common_1ga87f11e55659b2b3a81c21f72668b3cac>`(const char* uuid);
	char* :ref:`tapi_upnp_get_st_device_type<doxid-group__tapi__upnp__common_1gac1fd42a29846bd829389462f693f12cf>`(const char* domain, const char* device_type);
	char* :ref:`tapi_upnp_get_st_service_type<doxid-group__tapi__upnp__common_1ga9346751081d7a50dcac99e18a6dc7371>`(const char* domain, const char* service_type);
	static char* :ref:`tapi_upnp_get_st_upnp_forum_device_type<doxid-group__tapi__upnp__common_1ga51998aaadceb567bafc6fb48723b74ed>`(const char* device_type);
	static char* :ref:`tapi_upnp_get_st_upnp_forum_service_type<doxid-group__tapi__upnp__common_1gac2c453825a3f9d0bb0a91ece41d76924>`(const char* service_type);

	// macros

	#define :ref:`TAPI_UPNP_ST_ALL_RESOURCES<doxid-group__tapi__upnp__common_1ga0820992d323bc9466f532d8b11200762>`
	#define :ref:`TAPI_UPNP_ST_ALL_ROOT_DEVICES<doxid-group__tapi__upnp__common_1ga5a8c991ee46ea80dd9c3f74816838922>`
	#define :ref:`TAPI_UPNP_ST_CONTENT_DIRECTORY<doxid-group__tapi__upnp__common_1gaca48c84f3d419615c6eb0a9eca4d6841>`

.. _details-group__tapi__upnp__common:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Definition of Test API DLNA UPnP commons.

Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved.

Global Functions
----------------

.. index:: pair: function; tapi_upnp_get_st_uuid
.. _doxid-group__tapi__upnp__common_1ga87f11e55659b2b3a81c21f72668b3cac:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* tapi_upnp_get_st_uuid(const char* uuid)

Build Search Target for a particular device. User should care about freeing memory allocated for output string.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- uuid

		- UUID Specified by UPnP vendor.



.. rubric:: Returns:

Search Target string, or ``NULL`` on error.

.. index:: pair: function; tapi_upnp_get_st_device_type
.. _doxid-group__tapi__upnp__common_1gac1fd42a29846bd829389462f693f12cf:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* tapi_upnp_get_st_device_type(const char* domain, const char* device_type)

Build Search Target for any device of particular type and a Vendor Domain Name. User should care about freeing memory allocated for output string.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- domain

		- Vendor Domain Name.

	*
		- device_type

		- Type of the Device.



.. rubric:: Returns:

Search Target string, or ``NULL`` on error.

.. index:: pair: function; tapi_upnp_get_st_service_type
.. _doxid-group__tapi__upnp__common_1ga9346751081d7a50dcac99e18a6dc7371:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	char* tapi_upnp_get_st_service_type(const char* domain, const char* service_type)

Build Search Target for any service of particular type and a Vendor Domain Name. User should care about freeing memory allocated for output string.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- domain

		- Vendor Domain Name.

	*
		- service_type

		- Type of the Service.



.. rubric:: Returns:

Search Target string, or ``NULL`` on error.

.. index:: pair: function; tapi_upnp_get_st_upnp_forum_device_type
.. _doxid-group__tapi__upnp__common_1ga51998aaadceb567bafc6fb48723b74ed:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static char* tapi_upnp_get_st_upnp_forum_device_type(const char* device_type)

Build Search Target for any device of particular type defined by the UPnP Forum working committee. User should care about freeing memory allocated for output string.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- device_type

		- Type of the Device.



.. rubric:: Returns:

Search Target string, or ``NULL`` on error.

.. index:: pair: function; tapi_upnp_get_st_upnp_forum_service_type
.. _doxid-group__tapi__upnp__common_1gac2c453825a3f9d0bb0a91ece41d76924:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static char* tapi_upnp_get_st_upnp_forum_service_type(const char* service_type)

Build Search Target for any service of particular type defined by the UPnP Forum working committee. User should care about freeing memory allocated for output string.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- service_type

		- Type of the Service.



.. rubric:: Returns:

Search Target string, or ``NULL`` on error.

Macros
------

.. index:: pair: define; TAPI_UPNP_ST_ALL_RESOURCES
.. _doxid-group__tapi__upnp__common_1ga0820992d323bc9466f532d8b11200762:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TAPI_UPNP_ST_ALL_RESOURCES

Search for all devices and services.

.. index:: pair: define; TAPI_UPNP_ST_ALL_ROOT_DEVICES
.. _doxid-group__tapi__upnp__common_1ga5a8c991ee46ea80dd9c3f74816838922:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TAPI_UPNP_ST_ALL_ROOT_DEVICES

Search for root devices only.

.. index:: pair: define; TAPI_UPNP_ST_CONTENT_DIRECTORY
.. _doxid-group__tapi__upnp__common_1gaca48c84f3d419615c6eb0a9eca4d6841:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define TAPI_UPNP_ST_CONTENT_DIRECTORY

Search for Content Directory service only.