RemoteParameterDetails Struct Reference

This datatype is used to denote that a Parameter is for use on a PairedService. More...

#include <remote_parameter_details.h>

Public Member Functions
RemoteParameterDetails *	AllocateRemoteParameterDetails (const char *const uri_s, const char *const param_s)
	Allocate a RemoteParameterDetails. More...
void	FreeRemoteParameterDetails (RemoteParameterDetails *details_p)
	Free a RemoteParameterDetails. More...
json_t *	GetRemoteParameterDetailsAsJSON (const RemoteParameterDetails *details_p)
	Get the JSON fragment representing a RemoteParameterDetails. More...
RemoteParameterDetails *	CreateRemoteParameterDetailsFromJSON (const json_t *json_p)
	Create a RemoteParameterDetails from a JSON fragment representation. More...

Data Fields
char *	rpd_server_uri_s
	If the Parameter belongs to a local Service, this will be NULL. More...
char *	rpd_name_s
	If the Parameter belongs to a local Service, this will be NULL. More...

Detailed Description

This datatype is used to denote that a Parameter is for use on a PairedService.

Member Function Documentation

AllocateRemoteParameterDetails()

RemoteParameterDetails * AllocateRemoteParameterDetails	(	const char *const	uri_s,
		const char *const	param_s
	)

Allocate a RemoteParameterDetails.

Parameters

uri_s	The URI of the ExternalServer that runs the PairedService that this RemoteParameter belongs to.
param_s	The name for this Parameter on the PairedService.

Returns

The new RemoteParameterDetails or NULL upon error.

FreeRemoteParameterDetails()

void FreeRemoteParameterDetails

(

RemoteParameterDetails *

details_p

)

Free a RemoteParameterDetails.

Parameters

details_p

The RemoteParameterDetails to free.

GetRemoteParameterDetailsAsJSON()

json_t * GetRemoteParameterDetailsAsJSON

(

const RemoteParameterDetails *

details_p

)

Get the JSON fragment representing a RemoteParameterDetails.

Parameters

details_p

The RemoteParameterDetails to get the JSON fragment for.

Returns

The JSON fragment or NULL upon error.

See also

CreateRemoteParameterDetailsFromJSON

CreateRemoteParameterDetailsFromJSON()

RemoteParameterDetails * CreateRemoteParameterDetailsFromJSON

(

const json_t *

json_p

)

Create a RemoteParameterDetails from a JSON fragment representation.

Parameters

json_p

The JSON fragment representing the RemoteParameterDetails to get.

Returns

The RemoteParameterDetails or NULL upon error.

See also

GetRemoteParameterDetailsAsJSON

Field Documentation

rpd_server_uri_s

char* rpd_server_uri_s

If the Parameter belongs to a local Service, this will be NULL.

If it is for an external Service, then this is the uri for the ExternalServer running that Service.

rpd_name_s

char* rpd_name_s

If the Parameter belongs to a local Service, this will be NULL.

If it is for an external Service, then this is the name for the ExternalServer's Parameter running that Service.

---

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

• remote_parameter_details.h