xchange v1.0
Structured data exchange for C/C++
Loading...
Searching...
No Matches
XField Struct Reference

An SMA-X field, typically as part of an XStructure. A field may be a reference to a nested XStructure itself. More...

#include <xchange.h>

Data Fields

boolean isSerialized
 Whether the fields is stored in serialized (string) format.
 
char * name
 
int ndim
 The dimensionality of the data.
 
struct XFieldnext
 Pointer to the next linked element (if inside an XStructure).
 
int sizes [X_MAX_DIMS]
 The sizes along each dimension.
 
char * subtype
 
XType type
 The underlyng data type.
 
void * value
 

Detailed Description

An SMA-X field, typically as part of an XStructure. A field may be a reference to a nested XStructure itself.

See also
smaxCreateField()
smaxCreateScalarField()
smaxCreate1DField()
smaxDestroyField()
smaxShareField()

Field Documentation

◆ name

char* name

Pointer to a designated local name buffer. It may not contain a separator (see X_SEP). NOTE: it should normally be dynamically allocated, to work with xClearField() / xDestroyField().

◆ subtype

char* subtype

(optional) Descriptive subtype, such a a mime type or encoding (if any). It is entirely up to the user / application to assing meaning to this field. NOTE: it should normally be dynamically allocated, to work with xClearField() / xDestroyField().

◆ value

void* value

Pointer to designated local string content (or structure)... NOTE: it should normally be dynamically allocated, to work with xClearField() / xDestroyField().


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