Imex_Topo_Import_Logged()
Abstract
Imports topology from a self-documenting text file, using a custom log procedure to log errors.
Syntax
Imex_Topo_Import_Logged (file_name, log_proc)
| Argument | Type | Description |
|---|---|---|
file_name |
char * |
full path of the text file to be imported |
log_proc |
ImexT_Log_Proc |
procedure used to log errors, or PRGC_NIL (see Details) |
Return Type
PrgT_Compcode
PrgC_Compcode_Failure for failure; PrgC_Compcode_Success for success.
Header
imex.h
Details
Imports a network topology from a self-documenting text file into the current scenario. The text file must conform to the documented format called TEF. Calling this function automates the process of creating objects within the current scenario. The function performs all parsing, object creation, and assignment of attributes for the objects. Before importing, the current network is cleared (all nodes and links are removed).
Errors discovered in the input text file are logged using the logging procedure specified by log_proc. The logging procedure can be the default procedure obtained with Imex_Default_Log_Proc_Get() or a user-written procedure. The prototype for the logging procedure callback is given in ImexT_Log_Proc. If log_proc is PRGC_NIL, no messages are logged.