diff -r 92e482410453 -r d345541018fa docs/api-2.1/structUcxProperties.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/api-2.1/structUcxProperties.html Sat Feb 06 19:11:44 2021 +0100 @@ -0,0 +1,313 @@ + + + + + + + +ucx: UcxProperties Struct Reference + + + + + + + + + +
+
+ + + + + + + +
+
ucx +
+
UAP Common Extensions
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Data Fields
+
+
UcxProperties Struct Reference
+
+
+ +

UcxProperties object for parsing properties data. + More...

+ +

#include <properties.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Data Fields

char * buffer
 Input buffer (don't set manually). More...
 
size_t buflen
 Length of the input buffer (don't set manually). More...
 
size_t pos
 Current buffer position (don't set manually). More...
 
char * tmp
 Internal temporary buffer (don't set manually). More...
 
size_t tmplen
 Internal temporary buffer length (don't set manually). More...
 
size_t tmpcap
 Internal temporary buffer capacity (don't set manually). More...
 
int error
 Parser error code. More...
 
char delimiter
 The delimiter that shall be used. More...
 
char comment1
 The first comment character. More...
 
char comment2
 The second comment character. More...
 
char comment3
 The third comment character. More...
 
+

Detailed Description

+

UcxProperties object for parsing properties data.

+

Most of the fields are for internal use only. You may configure the properties parser, e.g. by changing the used delimiter or specifying up to three different characters that shall introduce comments.

+

Field Documentation

+ +

◆ buffer

+ +
+
+ + + + +
char* UcxProperties::buffer
+
+ +

Input buffer (don't set manually).

+

Automatically set by calls to ucx_properties_fill().

+ +
+
+ +

◆ buflen

+ +
+
+ + + + +
size_t UcxProperties::buflen
+
+ +

Length of the input buffer (don't set manually).

+

Automatically set by calls to ucx_properties_fill().

+ +
+
+ +

◆ comment1

+ +
+
+ + + + +
char UcxProperties::comment1
+
+ +

The first comment character.

+

This is '#' by default.

+ +
+
+ +

◆ comment2

+ +
+
+ + + + +
char UcxProperties::comment2
+
+ +

The second comment character.

+

This is not set by default.

+ +
+
+ +

◆ comment3

+ +
+
+ + + + +
char UcxProperties::comment3
+
+ +

The third comment character.

+

This is not set by default.

+ +
+
+ +

◆ delimiter

+ +
+
+ + + + +
char UcxProperties::delimiter
+
+ +

The delimiter that shall be used.

+

This is '=' by default.

+ +
+
+ +

◆ error

+ +
+
+ + + + +
int UcxProperties::error
+
+ +

Parser error code.

+

This is always 0 on success and a nonzero value on syntax errors. The value is set by ucx_properties_next().

+ +
+
+ +

◆ pos

+ +
+
+ + + + +
size_t UcxProperties::pos
+
+ +

Current buffer position (don't set manually).

+

Used by ucx_properties_next().

+ +
+
+ +

◆ tmp

+ +
+
+ + + + +
char* UcxProperties::tmp
+
+ +

Internal temporary buffer (don't set manually).

+

Used by ucx_properties_next().

+ +
+
+ +

◆ tmpcap

+ +
+
+ + + + +
size_t UcxProperties::tmpcap
+
+ +

Internal temporary buffer capacity (don't set manually).

+

Used by ucx_properties_next().

+ +
+
+ +

◆ tmplen

+ +
+
+ + + + +
size_t UcxProperties::tmplen
+
+ +

Internal temporary buffer length (don't set manually).

+

Used by ucx_properties_next().

+ +
+
+
The documentation for this struct was generated from the following file: +
+ +
+Generated on Thu Dec 19 2019 19:58:24 for ucx by   +doxygen + 1.8.13 +
+ +