rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

Classes | Macros | Enumerations
calendar.h File Reference
#include <ilog/macros.h>
#include <ilog/string.h>

Classes

class  IlCalendar
 Abstract base class managing a calendar date. More...
 
class  IlTimeZone
 Dummy IlTimeZone class - not really used. More...
 

Macros

#define IL_DATE_FAILURE(x)
 Tests a IlDateErrorCode value for failure. More...
 
#define IL_DATE_MILLIS_PER_DAY
 The number of milliseconds in 1 day.
 
#define IL_DATE_MILLIS_PER_HOUR
 The number of milliseconds in 1 hour.
 
#define IL_DATE_MILLIS_PER_MINUTE
 The number of milliseconds in 1 minute.
 
#define IL_DATE_MILLIS_PER_SECOND
 The number of milliseconds in 1 second.
 
#define IL_DATE_SUCCESS(x)
 Tests a IlDateErrorCode value for success. More...
 

Enumerations

enum  IlDateErrorCode {
  IL_DATE_ERROR_INFO_START, IL_DATE_USING_FALLBACK_ERROR, IL_DATE_USING_DEFAULT_ERROR, IL_DATE_SAFECLONE_ALLOCATED_ERROR,
  IL_DATE_ERROR_INFO_LIMIT, IL_DATE_ZERO_ERROR, IL_DATE_ILLEGAL_ARGUMENT_ERROR , IL_DATE_INTERNAL_PROGRAM_ERROR ,
  IL_DATE_MEMORY_ALLOCATION_ERROR , IL_DATE_PARSE_ERROR, IL_DATE_INVALID_CHAR_FOUND, IL_DATE_TRUNCATED_CHAR_FOUND,
  IL_DATE_ILLEGAL_CHAR_FOUND, IL_DATE_INVALID_TABLE_FORMAT, IL_DATE_INVALID_TABLE_FILE, IL_DATE_BUFFER_OVERFLOW_ERROR,
  IL_DATE_UNSUPPORTED_ERROR, IL_DATE_RESOURCE_TYPE_MISMATCH, IL_DATE_ILLEGAL_ESCAPE_SEQUENCE, IL_DATE_UNSUPPORTED_ESCAPE_SEQUENCE,
  IL_DATE_NO_SPACE_AVAILABLE, IL_DATE_ERROR_LIMIT
}
 Error code to replace exception handling so that the code is compatible with all C++ compilers, and to use the same mechanism for C and C++. More...
 

Detailed Description

[library ilog ilog/calendar.h] IlCalendar class. From IBM ICU classes, adapted for Rogue Wave Views libraries.
Copyright (C) 1997-1999, International Business Machines Corporation and others. All Rights Reserved.

Macro Definition Documentation

#define IL_DATE_FAILURE (   x)

Tests a IlDateErrorCode value for failure.

Returns
1 if the value is an error, 0 otherwise
#define IL_DATE_SUCCESS (   x)

Tests a IlDateErrorCode value for success.

Returns
1 if the value is not error, 0 otherwise

Enumeration Type Documentation

Error code to replace exception handling so that the code is compatible with all C++ compilers, and to use the same mechanism for C and C++.

Functions that take a reference (C++) or a pointer (C) to a IlDateErrorCode first test
if (IL_DATE_FAILURE(errorCode)) { return immediately; }
so that in a chain of such functions the first one that sets an error code causes the following ones to not perform any operations.
Error codes should be tested using IL_DATE_FAILURE() and IL_DATE_SUCCESS().

Enumerator
IL_DATE_ERROR_INFO_START 

Start of information results (semantically successful).

IL_DATE_USING_FALLBACK_ERROR 

A resource bundle lookup returned a fallback result (not an error).

IL_DATE_USING_DEFAULT_ERROR 

A resource bundle lookup returned a result from the root locale (not an error).

IL_DATE_SAFECLONE_ALLOCATED_ERROR 

A SafeClone operation required allocating memory (informational only).

IL_DATE_ERROR_INFO_LIMIT 

This must always be the last warning value to indicate the limit for IlDateErrorCode warnings (last warning code +1).

IL_DATE_ZERO_ERROR 

No error, no warning.

IL_DATE_ILLEGAL_ARGUMENT_ERROR 

Start of codes indicating failure.

IL_DATE_INTERNAL_PROGRAM_ERROR 

Indicates a bug in the library code.

IL_DATE_MEMORY_ALLOCATION_ERROR 

Memory allocation error.

IL_DATE_PARSE_ERROR 

Equivalent to Java ParseException.

IL_DATE_INVALID_CHAR_FOUND 

In the Character conversion routines: Invalid character or sequence was encountered.

IL_DATE_TRUNCATED_CHAR_FOUND 

In the Character conversion routines: More bytes are required to complete the conversion successfully.

IL_DATE_ILLEGAL_CHAR_FOUND 

In codeset conversion: a sequence that does NOT belong in the codepage has been encountered.

IL_DATE_INVALID_TABLE_FORMAT 

Conversion table file found, but corrupted.

IL_DATE_INVALID_TABLE_FILE 

Conversion table file not found.

IL_DATE_BUFFER_OVERFLOW_ERROR 

A result would not fit in the supplied buffer.

IL_DATE_UNSUPPORTED_ERROR 

Requested operation not supported in current context.

IL_DATE_RESOURCE_TYPE_MISMATCH 

An operation is requested over a resource that does not support it.

IL_DATE_ILLEGAL_ESCAPE_SEQUENCE 

ISO-2022 illegal escape sequence.

IL_DATE_UNSUPPORTED_ESCAPE_SEQUENCE 

ISO-2022 unsupported escape sequence.

IL_DATE_NO_SPACE_AVAILABLE 

No space available for in-buffer expansion for Arabic shaping.

IL_DATE_ERROR_LIMIT 

This must always be the last value to indicate the limit for IlDateErrorCode (last error code +1).


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.