theConfig 10.0
Loading...
Searching...
No Matches
LcSettingC_Lookup_CC_API

LcSettingC - various functions to lookup a settingMore...

+ Collaboration diagram for LcSettingC_Lookup_CC_API:

Functions

LcSettingCcclcconfig::LcSettingC::Lookup (MK_STRN path)
  C++: LcSettingC* setting.Lookup(MK_STRN path) C-API
This function locates a setting by a path path relative to the setting setting
 
LcSettingCcclcconfig::LcSettingC::Lookup (const std::string &path)
  C++: LcSettingC* setting.Lookup(MK_STRN path) C-API
This function locates a setting by a path path relative to the setting setting
 
MkBufferListCcclcconfig::LcSettingC::LookupAll () const
  C++: MkBufferListC* setting.LookupAll() C-API
addon - read an entire configuration below setting into MkBufferListC
 
MK_BOOL cclcconfig::LcSettingC::LookupBool (MK_STRN name) const
  C++: MK_BOOL setting.LookupBool(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting
 
MK_BOOL cclcconfig::LcSettingC::LookupBool (const std::string &name) const
  C++: MK_BOOL setting.LookupBool(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting
 
MK_DBL cclcconfig::LcSettingC::LookupFloat (MK_STRN name) const
  C++: MK_DBL setting.LookupFloat(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting
 
MK_DBL cclcconfig::LcSettingC::LookupFloat (const std::string &name) const
  C++: MK_DBL setting.LookupFloat(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting
 
MK_I32 cclcconfig::LcSettingC::LookupInt (MK_STRN name) const
  C++: MK_I32 setting.LookupInt(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting
 
MK_I32 cclcconfig::LcSettingC::LookupInt (const std::string &name) const
  C++: MK_I32 setting.LookupInt(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting
 
MK_I64 cclcconfig::LcSettingC::LookupInt64 (MK_STRN name) const
  C++: MK_I64 setting.LookupInt64(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting
 
MK_I64 cclcconfig::LcSettingC::LookupInt64 (const std::string &name) const
  C++: MK_I64 setting.LookupInt64(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting
 
MK_STRN cclcconfig::LcSettingC::LookupString (MK_STRN name) const
  C++: MK_STRN setting.LookupString(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting
 
MK_STRN cclcconfig::LcSettingC::LookupString (const std::string &name) const
  C++: MK_STRN setting.LookupString(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting
 

Detailed Description

LcSettingC - various functions to lookup a setting

Function Documentation

◆ Lookup() [1/2]

LcSettingC * cclcconfig::LcSettingC::Lookup ( const std::string & path)
inline

C++: LcSettingC* setting.Lookup(MK_STRN path) C-API
This function locates a setting by a path path relative to the setting setting

Definition at line 294 of file LcSettingC_inline_cc.hh.

294 {
295 MK_UNUSED auto setting = getCFS();
296 const MK_STRN path_hdl = path.c_str();
297 LC_CFS __retVal__L = LcSettingLookup(setting, path_hdl);
298 if (__retVal__L == NULL) {
299 throw MkInitSoftError("LcSettingC::Lookup");
300 }
301 return LcSettingC::LcSettingC_ObjNew(MK_RT_CALL __retVal__L);
302 }
LC_CFS getCFS() const
return the LibMsgqueObject from current LcSettingC instance
static LcSettingC * LcSettingC_ObjNew(MK_RT_ARGS LC_CFS hdl)
return LcSettingC from LibMsgqueObject
struct LcSettingS * LC_CFS
class-shortcut for struct LcSettingS *, all shortcut using the XX_YYY syntax (only for public API) …
static LC_CFS LcSettingLookup(LC_CFS setting, MK_STRN path)
This function locates a setting by a path path relative to the setting setting …
#define MK_UNUSED
const MK_STRB * MK_STRN
#define MK_RT_CALL

◆ Lookup() [2/2]

LcSettingC * cclcconfig::LcSettingC::Lookup ( MK_STRN path)
inline

C++: LcSettingC* setting.Lookup(MK_STRN path) C-API
This function locates a setting by a path path relative to the setting setting

Definition at line 284 of file LcSettingC_inline_cc.hh.

284 {
285 MK_UNUSED auto setting = getCFS();
286 LC_CFS __retVal__L = LcSettingLookup(setting, path);
287 if (__retVal__L == NULL) {
288 throw MkInitSoftError("LcSettingC::Lookup");
289 }
290 return LcSettingC::LcSettingC_ObjNew(MK_RT_CALL __retVal__L);
291 }

◆ LookupAll()

MkBufferListC * cclcconfig::LcSettingC::LookupAll ( ) const
inline

C++: MkBufferListC* setting.LookupAll() C-API
addon - read an entire configuration below setting into MkBufferListC

Definition at line 305 of file LcSettingC_inline_cc.hh.

305 {
306 MK_UNUSED auto setting = getCFSN();
307 MK_BFL __retVal__L = LcSettingLookupAll(setting);
309 }
LC_CFSN getCFSN() const
(const) return the LibMsgqueObject from current LcSettingC instance
MK_BFL LcSettingLookupAll(LC_CFSN setting)
addon - read an entire configuration below setting into MkBufferListC …
static MkBufferListC * MkBufferListC_ObjNew(MK_RT_ARGS MK_BFL hdl)
struct MkBufferListS * MK_BFL

◆ LookupBool() [1/2]

MK_BOOL cclcconfig::LcSettingC::LookupBool ( const std::string & name) const
inline

C++: MK_BOOL setting.LookupBool(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting

Definition at line 323 of file LcSettingC_inline_cc.hh.

323 {
324 MK_UNUSED auto setting = getCFSN();
325 MK_BOOL value_out;
326 const MK_STRN name_hdl = name.c_str();
327 enum MkErrorE errVal = LcSettingLookupBool(setting, name_hdl, &value_out);
328 MkErrorC_Check(setting, errVal);
329 return value_out;
330 }
static enum MkErrorE LcSettingLookupBool(LC_CFSN setting, MK_STRN name, MK_BOOL *value_out)
These functions look up the value of the child setting named name of the setting setting …

◆ LookupBool() [2/2]

MK_BOOL cclcconfig::LcSettingC::LookupBool ( MK_STRN name) const
inline

C++: MK_BOOL setting.LookupBool(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting

Definition at line 314 of file LcSettingC_inline_cc.hh.

314 {
315 MK_UNUSED auto setting = getCFSN();
316 MK_BOOL value_out;
317 enum MkErrorE errVal = LcSettingLookupBool(setting, name, &value_out);
318 MkErrorC_Check(setting, errVal);
319 return value_out;
320 }

◆ LookupFloat() [1/2]

MK_DBL cclcconfig::LcSettingC::LookupFloat ( const std::string & name) const
inline

C++: MK_DBL setting.LookupFloat(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting

Definition at line 342 of file LcSettingC_inline_cc.hh.

342 {
343 MK_UNUSED auto setting = getCFSN();
344 MK_DBL value_out;
345 const MK_STRN name_hdl = name.c_str();
346 enum MkErrorE errVal = LcSettingLookupFloat(setting, name_hdl, &value_out);
347 MkErrorC_Check(setting, errVal);
348 return value_out;
349 }
static enum MkErrorE LcSettingLookupFloat(LC_CFSN setting, MK_STRN name, MK_DBL *value_out)
These functions look up the value of the child setting named name of the setting setting …
double MK_DBL

◆ LookupFloat() [2/2]

MK_DBL cclcconfig::LcSettingC::LookupFloat ( MK_STRN name) const
inline

C++: MK_DBL setting.LookupFloat(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting

Definition at line 333 of file LcSettingC_inline_cc.hh.

333 {
334 MK_UNUSED auto setting = getCFSN();
335 MK_DBL value_out;
336 enum MkErrorE errVal = LcSettingLookupFloat(setting, name, &value_out);
337 MkErrorC_Check(setting, errVal);
338 return value_out;
339 }

◆ LookupInt() [1/2]

MK_I32 cclcconfig::LcSettingC::LookupInt ( const std::string & name) const
inline

C++: MK_I32 setting.LookupInt(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting

Definition at line 361 of file LcSettingC_inline_cc.hh.

361 {
362 MK_UNUSED auto setting = getCFSN();
363 MK_I32 value_out;
364 const MK_STRN name_hdl = name.c_str();
365 enum MkErrorE errVal = LcSettingLookupInt(setting, name_hdl, &value_out);
366 MkErrorC_Check(setting, errVal);
367 return value_out;
368 }
static enum MkErrorE LcSettingLookupInt(LC_CFSN setting, MK_STRN name, MK_I32 *value_out)
These functions look up the value of the child setting named name of the setting setting …
signed int MK_I32

◆ LookupInt() [2/2]

MK_I32 cclcconfig::LcSettingC::LookupInt ( MK_STRN name) const
inline

C++: MK_I32 setting.LookupInt(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting

Definition at line 352 of file LcSettingC_inline_cc.hh.

352 {
353 MK_UNUSED auto setting = getCFSN();
354 MK_I32 value_out;
355 enum MkErrorE errVal = LcSettingLookupInt(setting, name, &value_out);
356 MkErrorC_Check(setting, errVal);
357 return value_out;
358 }

◆ LookupInt64() [1/2]

MK_I64 cclcconfig::LcSettingC::LookupInt64 ( const std::string & name) const
inline

C++: MK_I64 setting.LookupInt64(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting

Definition at line 380 of file LcSettingC_inline_cc.hh.

380 {
381 MK_UNUSED auto setting = getCFSN();
382 MK_I64 value_out;
383 const MK_STRN name_hdl = name.c_str();
384 enum MkErrorE errVal = LcSettingLookupInt64(setting, name_hdl, &value_out);
385 MkErrorC_Check(setting, errVal);
386 return value_out;
387 }
static enum MkErrorE LcSettingLookupInt64(LC_CFSN setting, MK_STRN name, MK_I64 *value_out)
These functions look up the value of the child setting named name of the setting setting …
signed long long MK_I64

◆ LookupInt64() [2/2]

MK_I64 cclcconfig::LcSettingC::LookupInt64 ( MK_STRN name) const
inline

C++: MK_I64 setting.LookupInt64(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting

Definition at line 371 of file LcSettingC_inline_cc.hh.

371 {
372 MK_UNUSED auto setting = getCFSN();
373 MK_I64 value_out;
374 enum MkErrorE errVal = LcSettingLookupInt64(setting, name, &value_out);
375 MkErrorC_Check(setting, errVal);
376 return value_out;
377 }

◆ LookupString() [1/2]

MK_STRN cclcconfig::LcSettingC::LookupString ( const std::string & name) const
inline

C++: MK_STRN setting.LookupString(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting

Definition at line 399 of file LcSettingC_inline_cc.hh.

399 {
400 MK_UNUSED auto setting = getCFSN();
401 MK_STRN value_out;
402 const MK_STRN name_hdl = name.c_str();
403 enum MkErrorE errVal = LcSettingLookupString(setting, name_hdl, &value_out);
404 MkErrorC_Check(setting, errVal);
405 return value_out;
406 }
static enum MkErrorE LcSettingLookupString(LC_CFSN setting, MK_STRN name, MK_STRN *value_out)
These functions look up the value of the child setting named name of the setting setting …

◆ LookupString() [2/2]

MK_STRN cclcconfig::LcSettingC::LookupString ( MK_STRN name) const
inline

C++: MK_STRN setting.LookupString(MK_STRN name) C-API
These functions look up the value of the child setting named name of the setting setting

Definition at line 390 of file LcSettingC_inline_cc.hh.

390 {
391 MK_UNUSED auto setting = getCFSN();
392 MK_STRN value_out;
393 enum MkErrorE errVal = LcSettingLookupString(setting, name, &value_out);
394 MkErrorC_Check(setting, errVal);
395 return value_out;
396 }