cavcontrolpoint.h File Reference

#include <stdarg.h>
#include <cybergarage/typedef.h>
#include <cybergarage/upnp/cservice.h>

Go to the source code of this file.

Functions

int cg_upnp_av_control_invokeaction (CgUpnpService *upnpService, char *actionName, char **errorString,...)
int cg_upnp_av_control_parseactionarguments (CgUpnpAction *action, BOOL inDirection, va_list *va)
BOOL cg_upnp_av_control_iserrorcodesuccessful (int errorCode)


Function Documentation

int cg_upnp_av_control_invokeaction CgUpnpService *  upnpService,
char *  actionName,
char **  errorString,
  ...
 

Invoke an action on the upnp device

Parameters:
upnpDevice The UPnP device
actionName The name of the action to invoke
errorString A newly-created error string if the action fails. Pass NULL if you don't want to use it.
numArgs The number of action-specific arguments
... A list of action-specific arguments
Returns:
An integer containing the UPnP status code
The list of action-specific arguments is a comma-separated list, that is organised as pairs of char* ARG_NAME and CgString* ARG_VALUE. ARG_NAME contains the name of the argument, while ARG_VALUE contains the value of the argument. You don't need to put anything inside OUT arguments, as they are not sent along with the action; their contents are set when the action post returns with OUT values that were received from the peer.

BOOL cg_upnp_av_control_iserrorcodesuccessful int  errorCode  ) 
 

Check, whether a UPnP error/status code is actually a success.

Parameters:
errorCode The error/status code
Returns:
TRUE if the code is not an error; otherwise FALSE

int cg_upnp_av_control_parseactionarguments CgUpnpAction *  action,
BOOL  inDirection,
va_list *  va
 

A helper function to set or get dynamic action arguments to/from an action.

Parameters:
action The UPnP action
inDirection Use TRUE for IN arguments, FALSE for OUT arguments
va The dynamic argument list, followed by a single NULL
Returns:
upnp error code


Generated on Mon Aug 14 10:23:32 2006 for CyberLinkC-AV by  doxygen 1.4.6