Logs


Functions

int CreateLog ()
int CloseLog (int LogId)
void Log (const char *format,...)
int WriteLog (int LogId, char *str)

Detailed Description

Logs are text files where the object can print strings and are kept during the whole execution of the waveform. They are saved in logs directory under phal-repositories

They must be explicity created by the object before using it (CreateLog)

Warning:
Currently only one log is supported

Function Documentation

int CloseLog ( int  LogId  ) 

Close a Log.

Closes and deallocates log resources for a given log.

Parameters:
LogId Log Identifier to close
Returns:
1 ok

0 error

int CreateLog (  ) 

Creates a log

Creates and allocates necessary resources for using a log file.

Returns:
> 0 Log identifier

-1 if error

void Log ( const char *  format,
  ... 
)

Log

Write formated string to default log (1)

int WriteLog ( int  LogId,
char *  str 
)

LogWrite

Writes a character string to a log

Warning:
String must ends with a ''
Parameters:
LogId Log identifier
str String to write
Returns:
1 ok

0 error


Generated on Thu Jul 29 19:37:21 2010 for ALOESoftwareAPI(SWAPI) by  doxygen 1.5.5