Single-Element Functions : List of Functions : stm_check_out_item

stm_check_out_item
Function Type
None
Description
Checks out a chart file (or any other configuration item file) into the current workarea.
Note: If the version string parameter is an empty string or NULL, the function regards the latest version of the chart/file in the Databank.
Syntax
stm_check_out_item (file_name, ext, version, with_lock, error_func, &status)
Status Codes
stm_success
stm_error_in_load_operation
Arguments
 
Rational Statemate chart/file extensions. The possible values are as follows:
sch Statechart
ach - Activity charts
mch - Module-charts
fch Flowcharts
dic - Global Definition Set files
qch - Sequence-Diagrams
uch - Use-Case-Diagrams
vsm - Continuous Diagrams
pnl Panel files
scp - Simulation SCL files
cnf - Simulation status files
wpf - Waveform Profiles
dyn_set - Simulation analysis profiles
mon - Monitor files
chk_mdl_set - Check Model Profiles
² dgl - Documentor templates
inc - Documentor include files
pnl - Prototype panels
config - Configuration files
tv - Task View files
mak - Makefiles
oil - OIL files
cfg - CFG files
c - Source(c) files
h - Header (h) files
rgenset - Rapid Prototyper Profiles
trg - Target files
rtrg - Rapid Target files
crd - Card files
rconfig - Rhapsody block Configuration files
ccf - Component Configuration files
dat - VSM Data files
wav - VSM Wave files
mat - VSM Mat. Files
m - VSM M. files
void (*) (const char* err_msg).
If the error_func pointer is not NULL, this function will be called with an error message string, when the returned status is not stm_success. The error function may be called more than once during one checkout operation, with different error messages.