xdas_buffer_desc_struct Struct Reference
[XDAS API]

XDAS UTF-8 content buffer descriptor. More...

#include <xdas.h>

Data Fields
size_t	length
char *	value

---

Detailed Description

XDAS UTF-8 content buffer descriptor.

Remarks:

If length is zero, then value is zero-terminated. If value is zero then the field is unused and length is ignored.

Changes to the original OpenGroup XDAS specification:

1) Replaced void * with char * on value field. Since buffer descriptors are always meant to point to constant UTF-8 character data it makes little sense to be so generic about the content type. Also, it's important to note that the original XDAS specification defined many of the functions as taking a const pointer to an xdas_buffer_t object, which did not do what was clearly intended - to protect the contents of the value field. A const xdas_buffer_t parameter only protected the address stored in the value field, not the contents of the value field. To protect the contents of the value field, the value field must be specified as "const" within the structure. We've chosen NOT to do this since the buffer only ever returns pointers to information in user specified buffers.

Definition at line 831 of file xdas.h.

---

Field Documentation

size_t xdas_buffer_desc_struct::length

Length of value in bytes.

Definition at line 833 of file xdas.h.

Referenced by main(), and xdas_internal_import_event_records().

char* xdas_buffer_desc_struct::value

Pointer to UTF-8 string data.

Definition at line 834 of file xdas.h.

Referenced by main(), and xdas_internal_import_event_records().

---

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

• libxdas/include/xdas.h