qof_entity_reference Struct Reference
[Reference: Referring to entities outside a partial book.]

#include <qofreference.h>

Detailed Description

External references in a partial QofBook.

For use by any session that deals with partial QofBooks. It is used by the entity copy functions and by the QSF backend. Creates a GList stored in the Book hashtable to contain repeated references for a single entity.

Definition at line 105 of file qofreference.h.


Data Fields
QofIdType	choice_type
QofIdType	type
GUID *	ref_guid
const QofParam *	param
const GUID *	ent_guid

Field Documentation

QofIdType qof_entity_reference::choice_type

Used when the reference is a QOF_TYPE_CHOICE type

stores the actual type of the reference from the list of available choices.

Definition at line 107 of file qofreference.h.

QofIdType qof_entity_reference::type

The type of the original entity - use the param->param_type to obtain the type of the reference entity. For a QOF_TYPE_COLLECT, obtain the collection and get the type from that.

Definition at line 109 of file qofreference.h.

GUID* qof_entity_reference::ref_guid

The GUID of the REFERENCE entity

Definition at line 112 of file qofreference.h.

const QofParam* qof_entity_reference::param

The parameter of the original entity to use to get or set the reference.

Definition at line 113 of file qofreference.h.

const GUID* qof_entity_reference::ent_guid

The GUID of the original entity.

Definition at line 115 of file qofreference.h.

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