api_get_all_user_attributes
List of: Functions
Subjects: History and Roll
Contents: Kernel

Action: Finds all attributes of a specified user type in a history stream.

Prototype: outcome api_get_all_user_attributes (


HISTORY_STREAM const* hs, // stream to search


int derivation_level, // number of levels


int attrib_type_code, // id of attrib type


ENTITY_LIST& attribs, // list to add to


logical active_only // backup type flag



= TRUE,


AcisOptions* ao = NULL // acis options


);

Includes: #include "kernel/acis.hxx"

#include "baseutil/logical.h"

#include "kernel/kernapi/api/api.hxx"

#include "kernel/kernapi/api/kernapi.hxx"

#include "kernel/kerndata/bulletin/bulletin.hxx"

#include "kernel/kerndata/lists/lists.hxx"

#include "kernel/kernapi/api/acis_options.hxx"

Description: This routine is intended to allow users to find all of "their" attributes in a history stream. A user will typically pass in his master attribute type code to obtain a list all attributes in the history stream specific to his company. Any such attributes found are added to the attribs list. This routine does not clear attributes since it has "append to" syntax. derivation_level specified the number of levels of derivation of the requested attribute type from ENTITY.


The active_only flag is intended for use immediately after restoring the history stream from a file. If active_only is FALSE, then backup copies of the requested attribute type are also returned, allowing the user to perform direct post-restore operations that may be necessary to rebind these attributes to user data.


This flag setting violates the encapsulation of the roll mechanism; it should be used with great caution and alternative solutions (such as using entity IDs) should be explored. This flag setting is only intended to give users access to their own attributes. Passing in a Spatial type code when active_only is FALSE results in undefined behavior, possibly returning the error "access to non-user bulletin board entities is not allowed".

Errors: access to non-user bulletin board entities is not allowed

Library: kernel

Filename: kern/kernel/kernapi/api/kernapi.hxx

Effect: Read-only
PDF/KERN/16FNA.PDF
HTM/DATA/KERN/KERN/16FNA/0046.HTM