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

Action: Modifies the modeler state by applying zero or more delta_states.

Prototype: outcome api_change_to_state (


HISTORY_STREAM* hs, // history state to be




// applied


DELTA_STATE* ds, // delta state to be




// applied


int& n_actual // Number of delta states




// rolled returned


);

Includes: #include "kernel/acis.hxx"

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

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

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

Description: This API modifies the modeler's state to match that when the given delta state was first noted. The system finds the appropriate path through the history stream of which the delta state is a member.

Errors: The pointer to the delta state is NULL.

Library: kernel

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

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