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

char* UcxProperties::buffer

Input buffer (don't set manually).

Automatically set by calls to ucx_properties_fill().

size_t UcxProperties::buflen

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

Automatically set by calls to ucx_properties_fill().

char UcxProperties::comment1

The first comment character.

This is '#' by default.

char UcxProperties::comment2

The second comment character.

This is not set by default.

char UcxProperties::comment3

The third comment character.

This is not set by default.

char UcxProperties::delimiter

The delimiter that shall be used.

This is '=' by default.

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().

size_t UcxProperties::pos

Current buffer position (don't set manually).

Used by ucx_properties_next().

char* UcxProperties::tmp

Internal temporary buffer (don't set manually).

Used by ucx_properties_next().

size_t UcxProperties::tmpcap

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

Used by ucx_properties_next().

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: