AceCommon  1.6.0
Arduino library for low-level common functions and features with no external dependencies
Public Member Functions | List of all members
ace_common::KStringKeywords Class Reference

A thin helper object around an array of const char* in regular memory, or an array of const __FlashStringHelper* in flash memory. More...

#include <KString.h>

Public Member Functions

 KStringKeywords (uint8_t type, const void *const *keywords)
 
const char * get (uint8_t i) const
 Return the string pointer of index i. More...
 

Detailed Description

A thin helper object around an array of const char* in regular memory, or an array of const __FlashStringHelper* in flash memory.

Simplifies some code in KString.cpp.

Definition at line 175 of file KString.h.

Constructor & Destructor Documentation

◆ KStringKeywords()

ace_common::KStringKeywords::KStringKeywords ( uint8_t  type,
const void *const *  keywords 
)
inline
Parameters
typestorage type of keywords, either KString::kTypeCstring or KString::kTypeFstring
keywordsan array of pointers to strings, either in normal memory or flash memory

Definition at line 183 of file KString.h.

Member Function Documentation

◆ get()

const char* ace_common::KStringKeywords::get ( uint8_t  i) const
inline

Return the string pointer of index i.

The actual pointer type is either cstring or an fstring, depending on the type passed into the constructor.

Definition at line 193 of file KString.h.


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