cupnp_status.h File Reference

#include <cybergarage/typedef.h>
#include <cybergarage/util/cstring.h>

Data Structures
struct	_CgUpnpStatus
Defines
#define	CG_UPNP_STATUS_INVALID_ACTION   401
#define	CG_UPNP_STATUS_INVALID_ARGS   402
#define	CG_UPNP_STATUS_OUT_OF_SYNC   403
#define	CG_UPNP_STATUS_INVALID_VAR   404
#define	CG_UPNP_STATUS_ACTION_FAILED   501
#define	cg_upnp_status_setcode(upnpStat, value)   (upnpStat->code = value)
#define	cg_upnp_status_getcode(upnpStat)   (upnpStat->code)
#define	cg_upnp_status_setdescription(upnpStat, value)   cg_string_setvalue(upnpStat->description, value)
#define	cg_upnp_status_getdescription(upnpStat)   cg_string_getvalue(upnpStat->description)
Typedefs
typedef _CgUpnpStatus	CgUpnpStatus
Functions
CgUpnpStatus *	cg_upnp_status_new ()
void	cg_upnp_status_delete (CgUpnpStatus *upnpStat)
char *	cg_upnp_status_code2string (int code)

---

Define Documentation

#define CG_UPNP_STATUS_ACTION_FAILED   501

#define cg_upnp_status_getcode

(

upnpStat

)

(upnpStat->code)

Get Status code from a status struct

Parameters:

upnpStat

Status structure

#define cg_upnp_status_getdescription

(

upnpStat

)

cg_string_getvalue(upnpStat->description)

Get status description from a status struct

Parameters:

upnpStat

Status struct

#define CG_UPNP_STATUS_INVALID_ACTION   401

#define CG_UPNP_STATUS_INVALID_ARGS   402

#define CG_UPNP_STATUS_INVALID_VAR   404

#define CG_UPNP_STATUS_OUT_OF_SYNC   403

#define cg_upnp_status_setcode	(	upnpStat,
		value		)	(upnpStat->code = value)

Set status code for status struct

Parameters:

	upnpStat	Status struct
	value	Status code

#define cg_upnp_status_setdescription	(	upnpStat,
		value		)	cg_string_setvalue(upnpStat->description, value)

Set status description for a status struct

Parameters:

	upnpStat	Status struct
	value	Status description

---

Typedef Documentation

typedef struct _CgUpnpStatus CgUpnpStatus

UPnP status struct used in action and state operations

---

Function Documentation

char* cg_upnp_status_code2string

(

int

code

)

Helper function that converts a status code into a status description

Parameters:

code

Code to convert into a description

Returns:

Status description

void cg_upnp_status_delete

(

CgUpnpStatus *

upnpStat

)

Delete a status struct

Parameters:

upnpStat

Status struct to delete

CgUpnpStatus* cg_upnp_status_new

(

)

Create a new status struct

---