DataSource for C SDK  7.1.15.29888-517589a
Publishing Page Data

Functions

void ds_add_page_field (ds_data_t *data, int32_t fieldnum, const char *value)
 Add an arbitrary field to a page. More...
 
void ds_add_page_field_by_name (ds_data_t *data, const char *field, const char *value)
 Add an arbitrary field to a page. More...
 
void ds_add_page_row (ds_data_t *data, int row, int col, const char *str)
 Add a row of data to a page data object. More...
 
ds_data_tds_init_page (const char *subject, int rows, int cols, const char *type, unsigned short flags)
 Initialise a data object as a page. More...
 

Detailed Description

DataSource supports the contribution of pages, or sections of pages. Any individual character on a page can be updated.

See also
Sending DataSource Objects to Peers
Data Object Flags

Function Documentation

void ds_add_page_field ( ds_data_t data,
int32_t  fieldnum,
const char *  value 
)

Add an arbitrary field to a page.

Parameters
dataPage data object
fieldnumField number
valueValue of the field

This function can be used to add extra meta-data to page objects eg permissioning values for content based permissioning.

Note
Only field numbers up to 16383 are supported.
See also
ds_add_page_field_by_name()
void ds_add_page_field_by_name ( ds_data_t data,
const char *  field,
const char *  value 
)

Add an arbitrary field to a page.

Parameters
dataPage data object
fieldField name
valueValue of the field

This function can be used to add extra meta-data to page objects eg permissioning values for content based permissioning

See also
ds_add_page_field()
void ds_add_page_row ( ds_data_t data,
int  row,
int  col,
const char *  str 
)

Add a row of data to a page data object.

Parameters
dataThe page data object
rowThe row number to be added
colThe column to start at
strThe value of the data
ds_data_t* ds_init_page ( const char *  subject,
int  rows,
int  cols,
const char *  type,
unsigned short  flags 
)

Initialise a data object as a page.

Parameters
subjectThe name of the object
rowsNumber of rows
colsNumber of columns
typeOption type string
flagsObject flags

Pages can be any size up to a maximum of 256 rows and 191 columns. The flags argument should contain F_IMAGE on the first update to set the size, however this is not required if the page is the standard 80 columns by 25 rows.


Generated on Wed Jul 1 2020 19:56:22 for DataSource for C SDK