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

Action: Returns a unique integer identifier for a given ENTITY.

Prototype: outcome api_get_entity_id (


ENTITY* ent, // ENTITY for which id




// tag is requested


tag_id_type& id // returned id


);

Includes: #include "kernel/acis.hxx"

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

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

#include "kernel/kerndata/data/entity.hxx"

#include "kernel/kerndata/data/container.hxx"

Description: Returns a unique integer, in a particular HISTORY_STREAM, for a given ENTITY. This id number (tag) is evaluated lazily but, once requested, is saved with the HISTORY_STREAM and does not change on restore.

Library: kernel

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

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