PluginListNode Struct Reference
A ListNode for LinkedLists that also stores a plugin value. More...
#include <plugin.h>
Inheritance diagram for PluginListNode:
Collaboration diagram for PluginListNode:
Public Member Functions | |
| GRASSROOTS_PLUGIN_API PluginListNode * | AllocatePluginListNode (Plugin *const plugin_p) |
| Create a new PluginListNode. More... | |
| GRASSROOTS_PLUGIN_API void | FreePluginListNode (ListItem *const node_p) |
| Free a PluginListNode. More... | |
Data Fields | |
| ListItem | pln_node |
| The ListNode. More... | |
| Plugin * | pln_plugin_p |
| The plugin. More... | |
| MEM_FLAG | pln_plugin_flag |
| How the memory for the Plugin is stored and freed. More... | |
 Data Fields inherited from ListItem | |
| ListItem * | ln_prev_p |
| A pointer to the previous ListItem. More... | |
| ListItem * | ln_next_p |
| A pointer to the next ListItem. More... | |
Detailed Description
A ListNode for LinkedLists that also stores a plugin value.
Member Function Documentation
◆ AllocatePluginListNode()
| GRASSROOTS_PLUGIN_API PluginListNode * AllocatePluginListNode | ( | Plugin *const | plugin_p | ) |
Create a new PluginListNode.
- Parameters
-
plugin_p The Plugin to store in the newly-created PluginListNode.
- Returns
- The new PluginListNode or
NULLupon error.
◆ FreePluginListNode()
| GRASSROOTS_PLUGIN_API void FreePluginListNode | ( | ListItem *const | node_p | ) |
Free a PluginListNode.
- Parameters
-
node_p The ListNode to free.
Field Documentation
◆ pln_node
| ListItem pln_node |
The ListNode.
◆ pln_plugin_p
| Plugin* pln_plugin_p |
The plugin.
◆ pln_plugin_flag
The documentation for this struct was generated from the following file:
