Utility Classes and Functions

Functions and classes of general purpose. More...

Category Description

Functions and classes of general purpose.

Classes
class	IlsLogfile
	This class can be used to display messages to the user. More...
class	IlsRefCounted
	Base class for object with reference counting used by IlsSmartPointer. More...
class	IlsSmartDoublyLinkedList< V, K, KM >
	This class provides a list of owned objects when a relation is created. This list must contain at least as many items as specified for the minimal cardinality. More...
class	IlsSmartPointer< PointedType >
	This class lets you declare smart pointers to objects of a given type. Objects referenced by smart pointers are automatically destroyed when their reference counter drops to zero. More...
class	IlsString
	Implements a null-terminated string. More...
class	IlsStringFactory
	This class can be used to implement a string factory that will be used by the class IlsString. More...
class	IlsTime
	This class is used to set a timeout that determines how long a view server will wait for a request. More...
class	IlsTimer
	This class manages a Visualization Server timer that will call a callback function when it expires. More...
class	IlsTimerManager
	This singleton manages all the timers that have been posted in the application. More...
class	IlsTimerManagerFactory
	This singleton is used to create a Timer Manager when necessary. More...
class	IlsLogfile::MsgDescription
	Gives access to the characteristics of the messages handled by the class IlsLogfile. More...

Typedefs
typedef bool	IlsBoolean
	The type IlsBoolean handles Boolean values. A Boolean value is true when set to IlsTrue and false when set to IlsFalse. More...
typedef unsigned long	IlsRefCount
	This numeric type stores reference counters.

Enumerations
enum	IlsLogLevel {   ILS_LOG_UNSET, ILS_LOG_DEBUG, ILS_LOG_WARNING, ILS_LOG_INFO,   ILS_LOG_ERROR, ILS_LOG_FATALERROR, ILS_LOG_INTERNALERROR, ILS_LOG_MSG,   ILS_LOG_NOTHING }
	This enumerated type enumerates the various error types that can be generated by the system. More...
enum	IlsMoveDirective { ILS_BEGINNING, ILS_END }
	Contains two values that indicate the beginning and the end of a list. More...

Functions
void	IlsIlvSetLocale ()
	Locale setting for Views/Server applications. More...
void	IlsInit (const char *title, const char *notused, IlsWindowType windowType=default)
	This global function can be used on Windows® to control how messages are posted. More...
void	IlsSetLocaleOnce ()
	This global function must be called at the start of your main procedure or before you manipulate multibyte strings in your application. More...

Typedef Documentation

IlsBoolean

typedef bool IlsBoolean

The type IlsBoolean handles Boolean values. A Boolean value is true when set to IlsTrue and false when set to IlsFalse.

Library: server
and mvcomp

Enumeration Type Documentation

IlsLogLevel

enum IlsLogLevel

This enumerated type enumerates the various error types that can be generated by the system.

Library: server
and mvcomp

Note that, by default, only errors of type ILS_LOG_WARNING and greater are displayed by the system.

See also

IlsLogfile.

Enumerator
ILS_LOG_UNSET	unset
ILS_LOG_DEBUG	debug
ILS_LOG_WARNING	warning
ILS_LOG_INFO	info
ILS_LOG_ERROR	error
ILS_LOG_FATALERROR	fatal error
ILS_LOG_INTERNALERROR	internal error
ILS_LOG_MSG	message
ILS_LOG_NOTHING	nothing

IlsMoveDirective

enum IlsMoveDirective

Contains two values that indicate the beginning and the end of a list.

Library: server

Enumerator
ILS_BEGINNING	beginning of a list
ILS_END	end of a list

Function Documentation

IlsIlvSetLocale()

void IlsIlvSetLocale

(

)

Locale setting for Views/Server applications.

Library: server
and mvcomp

This global function calls both global functions IlvSetLanguage() and IlsSetLocaleOnce(). This is why it must be called instead of these global functions when using Rogue Wave Views with Rogue Wave Server.

See also

IlsString, IlsSetLocaleOnce().

IlsInit()

void IlsInit	(	const char *	title = 0,
		const char *	notused = 0,
		IlsWindowType	windowType = default
	)

This global function can be used on Windows® to control how messages are posted.

Library: server
and mvcomp

On non-Windows machines, this function does nothing.

This global function should always be the first function to be called in the main procedure.

Example

An example of how IlsInit is normally used is shown below:

main()
 
{
 
IlsInit("server");
 
...
 
}

Basic Types

Parameters

title	name that will appear in the title bar of the window or console, depending on how the application is compiled.
notused	not used
windowType	The parameter defaults to the value ILS_WINDOWTYPE_CONSOLE if compiling in console mode (that is, if the flag _CONSOLE is defined). Otherwise, it will take the value ILS_WINDOWTYPE_WINDOW. The value can be forced if necessary. A value of ILS_WINDOWTYPE_DEFAULT means that this value will be controlled via the environment variable ILS_FORCE_CONSOLE. If this environment variable is set, then the windowType used at runtime will be ILS_WINDOWTYPE_CONSOLE. Otherwise, the windowType used will be ILS_WINDOWTYPE_WINDOW. ILS_WINDOWTYPE_POP is the same windowType as ILS_WINDOWTYPE_WINDOW, except that when the window is iconized, this argument will make the window disappear and automatically pop up again as soon as there is some new output in the window. Forcing windowType to ILS_WINDOWTYPE_CONSOLE when compiling in the subsystem windows, or to ILS_WINDOWTYPE_WINDOW when compiling in the subsystem console, will cause all messages to be lost.

IlsSetLocaleOnce()

void IlsSetLocaleOnce

(

)

This global function must be called at the start of your main procedure or before you manipulate multibyte strings in your application.

Library: server
and mvcomp

This function can be safely called more than once.

See also

IlsString.