Platinum UPnP SDK  1.0.5.13
Public Member Functions | List of all members
PLT_ActionDesc Class Reference

The PLT_ActionDesc class provides information about a UPnP Service given action. More...

#include <PltAction.h>

Public Member Functions

 PLT_ActionDesc (const char *name, PLT_Service *service)
 Constructor. More...
 
PLT_ArgumentDescGetArgumentDesc (const char *name)
 Look for an argument given a name. More...
 
NPT_Array< PLT_ArgumentDesc * > & GetArgumentDescs ()
 Return an array of arguments. More...
 
const NPT_String & GetName () const
 Return the action name. More...
 
NPT_Result GetSCPDXML (NPT_XmlElementNode *node)
 Serialize action information to xml into an existing xml tree. More...
 
PLT_ServiceGetService ()
 Return the service the action is associated with. More...
 

Detailed Description

The PLT_ActionDesc class provides information about a UPnP Service given action.

This description has a name, a set of arguments and is associated to a service.

Constructor & Destructor Documentation

PLT_ActionDesc::PLT_ActionDesc ( const char *  name,
PLT_Service service 
)

Constructor.

Parameters
namethe action name
servicethe UPnP service the action is associated with

Member Function Documentation

PLT_ArgumentDesc* PLT_ActionDesc::GetArgumentDesc ( const char *  name)

Look for an argument given a name.

Parameters
nameargument name
Returns
PLT_ArgumentDesc pointer
NPT_Array<PLT_ArgumentDesc*>& PLT_ActionDesc::GetArgumentDescs ( )
inline

Return an array of arguments.

Returns
array of arguments
const NPT_String& PLT_ActionDesc::GetName ( ) const
inline

Return the action name.

Returns
action name.
NPT_Result PLT_ActionDesc::GetSCPDXML ( NPT_XmlElementNode *  node)

Serialize action information to xml into an existing xml tree.

Parameters
nodethe xml Element to serialize action information
PLT_Service* PLT_ActionDesc::GetService ( )

Return the service the action is associated with.


The documentation for this class was generated from the following file: