Synesis Software STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ...

Pantheios Util API


Detailed Description

To Be Defined.


Functions

char const * pantheios_getStockSeverityString (pan_sev_t severity)
 Returns a constant pointer to a non-NULL non-modifiable nul-terminated string representing the severity level.
size_t pantheios_getStockSeverityStringLength (pan_sev_t severity)
 Returns the length of the string returned by pantheios_getSeverityString().
char const * pantheios_getInitErrorString (int errCode)
 Returns a constant pointer to a non-NULL non-modifiable nul-terminated string representing the initialisation error.
size_t pantheios_getInitErrorStringLength (int errCode)
 Returns the length of the string returned by pantheios_getInitErrorString().


Function Documentation

char const* pantheios::pantheios_getInitErrorString ( int  errCode  ) 

Returns a constant pointer to a non-NULL non-modifiable nul-terminated string representing the initialisation error.

Parameters:
errCode The initialisation error code whose string explanation is to be returned. If the error code is not recognised, the empty string ("") will be returned.

size_t pantheios::pantheios_getInitErrorStringLength ( int  errCode  ) 

Returns the length of the string returned by pantheios_getInitErrorString().

Parameters:
errCode The initialisation error code whose string equivalent is to be returned. If the error code is not recognised, 0 will be returned.

char const* pantheios::pantheios_getStockSeverityString ( pan_sev_t  severity  ) 

Returns a constant pointer to a non-NULL non-modifiable nul-terminated string representing the severity level.

Parameters:
severity The severity level whose string equivalent is to be returned. Must be one of the PANTHEIOS_SEV_* enumerators, otherwise, the empty string ("") will be returned.

size_t pantheios::pantheios_getStockSeverityStringLength ( pan_sev_t  severity  ) 

Returns the length of the string returned by pantheios_getSeverityString().

Parameters:
severity The severity level whose string equivalent is to be returned. Must be one of the PANTHEIOS_SEV_* enumerators, otherwise, 0 will be returned.


pantheios Library documentation © Matthew Wilson, 2006-2008 SourceForge.net Logo