RemoteParameterDetailsNode Struct Reference

A ListItem for storing RemoteParameterDetails on a LinkedList. More...

#include <remote_parameter_details.h>

Inheritance diagram for RemoteParameterDetailsNode:
[legend]
Collaboration diagram for RemoteParameterDetailsNode:
[legend]

Public Member Functions

RemoteParameterDetailsNodeAllocateRemoteParameterDetailsNode (RemoteParameterDetails *details_p)
 Allocate a RemoteParameterDetailsNode. More...
 
RemoteParameterDetailsNodeAllocateRemoteParameterDetailsNodeByParts (const char *const uri_s, const char *const param_s)
 Allocate a new RemoteParameterDetailsNode and a new RemoteParameterDetails to store in it. More...
 
void FreeRemoteParameterDetailsNode (ListItem *node_p)
 Free a RemoteParameterDetailsNode. More...
 

Data Fields

ListItem rpdn_node
 The base node. More...
 
RemoteParameterDetailsrpdn_details_p
 The RemoteParameterDetails. More...
 
- Data Fields inherited from ListItem
ListItemln_prev_p
 A pointer to the previous ListItem. More...
 
ListItemln_next_p
 A pointer to the next ListItem. More...
 

Detailed Description

Member Function Documentation

◆ AllocateRemoteParameterDetailsNode()

RemoteParameterDetailsNode * AllocateRemoteParameterDetailsNode ( RemoteParameterDetails details_p)

Allocate a RemoteParameterDetailsNode.

Parameters
details_pThe RemoteParameterDetails to store in the new RemoteParameterDetailsNode.
Returns
The new RemoteParameterDetailsNode or NULL upon error.

◆ AllocateRemoteParameterDetailsNodeByParts()

RemoteParameterDetailsNode * AllocateRemoteParameterDetailsNodeByParts ( const char *const  uri_s,
const char *const  param_s 
)

Allocate a new RemoteParameterDetailsNode and a new RemoteParameterDetails to store in it.

Parameters
uri_sThe URI of the ExternalServer that runs the PairedService that this RemoteParameter belongs to.
param_sThe name for this Parameter on the PairedService.
Returns
The new RemoteParameterDetailsNode or NULL upon error.

◆ FreeRemoteParameterDetailsNode()

void FreeRemoteParameterDetailsNode ( ListItem node_p)

Free a RemoteParameterDetailsNode.

Parameters
node_pThe RemoteParameterDetailsNode to free.

Field Documentation

◆ rpdn_node

ListItem rpdn_node

The base node.

◆ rpdn_details_p


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