universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: ucx: UcxProperties Struct Reference universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390:
universe@390:
ucx universe@390:
universe@390:
UAP Common Extensions
universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390:
universe@390: universe@390:
universe@390: universe@390:
universe@390:
universe@390:
universe@390: Data Fields
universe@390:
universe@390:
UcxProperties Struct Reference
universe@390:
universe@390:
universe@390: universe@390:

UcxProperties object for parsing properties data. universe@390: More...

universe@390: universe@390:

#include <properties.h>

universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390: universe@390:

universe@390: 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...
 
universe@390:

Detailed Description

universe@390:

UcxProperties object for parsing properties data.

universe@390:

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.

universe@390:

Field Documentation

universe@390: universe@390:

◆ buffer

universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390:
char* UcxProperties::buffer
universe@390:
universe@390: universe@390:

Input buffer (don't set manually).

universe@390:

Automatically set by calls to ucx_properties_fill().

universe@390: universe@390:
universe@390:
universe@390: universe@390:

◆ buflen

universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390:
size_t UcxProperties::buflen
universe@390:
universe@390: universe@390:

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

universe@390:

Automatically set by calls to ucx_properties_fill().

universe@390: universe@390:
universe@390:
universe@390: universe@390:

◆ comment1

universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390:
char UcxProperties::comment1
universe@390:
universe@390: universe@390:

The first comment character.

universe@390:

This is '#' by default.

universe@390: universe@390:
universe@390:
universe@390: universe@390:

◆ comment2

universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390:
char UcxProperties::comment2
universe@390:
universe@390: universe@390:

The second comment character.

universe@390:

This is not set by default.

universe@390: universe@390:
universe@390:
universe@390: universe@390:

◆ comment3

universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390:
char UcxProperties::comment3
universe@390:
universe@390: universe@390:

The third comment character.

universe@390:

This is not set by default.

universe@390: universe@390:
universe@390:
universe@390: universe@390:

◆ delimiter

universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390:
char UcxProperties::delimiter
universe@390:
universe@390: universe@390:

The delimiter that shall be used.

universe@390:

This is '=' by default.

universe@390: universe@390:
universe@390:
universe@390: universe@390:

◆ error

universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390:
int UcxProperties::error
universe@390:
universe@390: universe@390:

Parser error code.

universe@390:

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

universe@390: universe@390:
universe@390:
universe@390: universe@390:

◆ pos

universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390:
size_t UcxProperties::pos
universe@390:
universe@390: universe@390:

Current buffer position (don't set manually).

universe@390:

Used by ucx_properties_next().

universe@390: universe@390:
universe@390:
universe@390: universe@390:

◆ tmp

universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390:
char* UcxProperties::tmp
universe@390:
universe@390: universe@390:

Internal temporary buffer (don't set manually).

universe@390:

Used by ucx_properties_next().

universe@390: universe@390:
universe@390:
universe@390: universe@390:

◆ tmpcap

universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390:
size_t UcxProperties::tmpcap
universe@390:
universe@390: universe@390:

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

universe@390:

Used by ucx_properties_next().

universe@390: universe@390:
universe@390:
universe@390: universe@390:

◆ tmplen

universe@390: universe@390:
universe@390:
universe@390: universe@390: universe@390: universe@390: universe@390:
size_t UcxProperties::tmplen
universe@390:
universe@390: universe@390:

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

universe@390:

Used by ucx_properties_next().

universe@390: universe@390:
universe@390:
universe@390:
The documentation for this struct was generated from the following file: universe@390:
universe@390: universe@390: universe@390: universe@390: