|
Action:
|
Returns an
ENTITY identified by the given id.
|
|
|
Prototype:
|
outcome api_get_entity_from_id (
|
|
|
tag_id_type id,
|
// id of the ENTITY
|
|
|
ENTITY*& returned_ent,
|
// returned ENTITY
|
|
|
HISTORY_STREAM* hs
|
// history where the
|
|
|
|
= NULL
|
// ENTITY lives
|
|
|
);
|
|
|
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/bulletin/bulletin.hxx"
|
|
#include "kernel/kerndata/data/container.hxx"
|
|
|
Description:
|
Returns the pointer to the
ENTITY identified by
id. If no
HISTORY_STREAM is specified, the default stream is used. If the
ENTITY corresponding to the id is not alive, a
NULL pointer is returned.
|
|
|
Errors:
|
id is not valid in the given stream.
|
|
|
Library:
|
kernel
|
|
|
Filename:
|
kern/kernel/kernapi/api/kernapi.hxx
|
|
|
Effect:
|
Read-only
|