Macros
#define	F_AUTHGLOBAL 0x0100
	Indicates that this update for an object (initially permission objects only) should be passed up to the auth module. More...

#define	F_AUTHUPDATE 0x4000
	This news update contains permissioning information. More...

#define	F_CHANGE_HEADLINE 0x0200
	Change the headline associated with the story code in this update to the headline contained in this update. More...

#define	F_CHANGEDFIELDS 0x8000
	Tells the liberator to only send on any changed fields. This tells the liberator compare this update with the cached data and only send on any changed fields to any subscribers. See the Liberator Admin Guide for details. More...

#define	F_CLEAR_PERM 0x0400
	Clear all permission keys for this update's symbolname. More...

#define	F_CLEAR_TYPE2 0x0400
	Clear all record type 2 entries for this update's symbolname. More...

#define	F_CLEAR_TYPE3 0x0100
	Clear all record type 3 entries this update's symbolname. More...

#define	F_CONSTITUENT_NOAUTH 0x4000
	The constituents in this container should noe be subject to permissioning. More...

#define	F_CREATEOBJECT 0x0010
	Create this object if it doesn't exist. More...

#define	F_CREATEPARENT 0x0020
	Create the parent directory if it doesn't exist. More...

#define	F_DELETE_HEADLINE 0x0100
	Delete the headline associated with the story code in this update. More...

#define	F_FILTER_PERM 0x0800
	Clears a permission key with the same value as the key fields present within this update. More...

#define	F_FILTER_TYPE2 0x0800
	Clears type 2 entries with the same value as the first field in this update. More...

#define	F_FILTER_TYPE3 0x0200
	Clears a type 3 entries with the same value as the first field in this update. More...

#define	F_IMAGE 0x1000
	This update is an image not a live update. All fields will be replaced by this update. More...

#define	F_NOCACHE 0x0400
	Do not cache this update - pass directly through to client. More...

#define	F_NONACTIVE 0x2000
	This object is not active, even if the DataSource is. For information on active data sources,. More...

Detailed Description

Various flags can be sent with a data object. These are set when the object is created with ds_init_data() or one of the object type specific init functions. These allow the receiving DataSource to handle the object in different ways, depending on the flags set. Some flags are only relevant to particular object types.

See also: Data Object Types

Macro Definition Documentation

#define F_AUTHGLOBAL 0x0100

Indicates that this update for an object (initially permission objects only) should be passed up to the auth module.

#define F_AUTHUPDATE 0x4000

This news update contains permissioning information.

#define F_CHANGE_HEADLINE 0x0200

Change the headline associated with the story code in this update to the headline contained in this update.

Note: This flag is only valid with DS_NEWS_TYPE data objects. Erroneous behaviour may result if applied to other data types.

#define F_CHANGEDFIELDS 0x8000

Tells the liberator to only send on any changed fields. This tells the liberator compare this update with the cached data and only send on any changed fields to any subscribers. See the Liberator Admin Guide for details.

#define F_CLEAR_PERM 0x0400

Clear all permission keys for this update's symbolname.

#define F_CLEAR_TYPE2 0x0400

Clear all record type 2 entries for this update's symbolname.

#define F_CLEAR_TYPE3 0x0100

Clear all record type 3 entries this update's symbolname.

#define F_CONSTITUENT_NOAUTH 0x4000

The constituents in this container should noe be subject to permissioning.

This flag only has effect on the initial update or any subsequent updates with the F_IMAGE flag set for the container. Setting this flag will prevent Liberator from applying auth module mapping and permissioning rules.

#define F_CREATEOBJECT 0x0010

Create this object if it doesn't exist.

#define F_CREATEPARENT 0x0020

Create the parent directory if it doesn't exist.

#define F_DELETE_HEADLINE 0x0100

Delete the headline associated with the story code in this update.

Note: This flag is only valid with DS_NEWS_TYPE data objects. Erroneous behaviour may result if paplied to other data types.

#define F_FILTER_PERM 0x0800

Clears a permission key with the same value as the key fields present within this update.

Multiple permission keys can be added to a single update:

 dsdata = ds_init_permission("/SUBJECT", "Key1", F_PERM_FILTER);
 ds_add_data(dsdata, DS_FIELDS_SEPARATOR, "");
 ds_add_permission_key(dsdata, "Key2");

#define F_FILTER_TYPE2 0x0800

Clears type 2 entries with the same value as the first field in this update.

If the first field within the update is that of a type 2 index field, then that type 2 entry is removed.

However, if the first field is not an index field, then all type 2 entries with the specified field/value combination will be removed. A string comparison is performed thus "22" will not match "22.00"

This flag should only be supplied to packets which have a type of DS_RECORD_TYPE2

#define F_FILTER_TYPE3 0x0200

Clears a type 3 entries with the same value as the first field in this update.

#define F_IMAGE 0x1000

This update is an image not a live update. All fields will be replaced by this update.

#define F_NOCACHE 0x0400

Do not cache this update - pass directly through to client.

Note: This flag is only relevant for DS_RECORD_TYPE data objects

#define F_NONACTIVE 0x2000

This object is not active, even if the DataSource is. For information on active data sources,.

Macros

Detailed Description

Macro Definition Documentation