lnerrors.h

IBM Lotus C++ API 7.0a for IBM Lotus Notes/Domino Directory Release --------- ------------------

//===========================================================================
//
// Module:	LNERRORS.H
//
// Description:
//
//		C++ API error and warning codes.
//
//===========================================================================
//
// Copyright (c) 1996-2004 Lotus Development Corporation. All rights reserved.
// This software is subject to the Lotus Software Agreement, Restricted
// Rights for U.S. government users, and applicable export regulations.
//
//===========================================================================

#ifndef LNGLOBAL_H
#include "lnglobal.h"
#endif


//-----	Error codes:


// General and session error codes:

LNERRDEF( ASSERT_FAILED, "Assertion failed" )
LNERRDEF( NO_ERROR_MESSAGE, "(no error message available)" )
LNERRDEF( NOT_FOUND, "No match found" )
LNERRDEF( NOT_IMPLEMENTED, "Function has not been implemented" )
LNERRDEF( OBSOLETE, "Function or type no longer supported" )
LNERRDEF( ILLEGAL_OPERATION, "This function is inappropriate for this object" )
LNERRDEF( UNANTICIPATED_FUNCTION_CALLED, \
	"This function should not be called in this situation" )
LNERRDEF( UNEXPECTED_CALLED, "unexpected() function called" )
LNERRDEF( TERMINATE_CALLED, "terminate() function called" )
LNERRDEF( WRONG_VERSION, \
	"API program is incompatible with this version of the API library" )
LNERRDEF( SESSION_NOT_INITIALIZED, "Notes session has not been initialized" )
LNERRDEF( SESSION_ALREADY_INITIALIZED, \
	"Notes session has already been initialized" )
LNERRDEF( CANNOT_REINIT_SESSION, \
	"Cannot initialize a new Notes session after calling Term" )
#ifdef MAC
LNERRDEF( NO_NOTES_INI, "The Notes Preferences file cannot be found")
#else
LNERRDEF( NO_NOTES_INI, \
	"The NOTES.INI file cannot be found on the search path (PATH)")
#endif
LNERRDEF( INVALID_LOGENTRY, "LogEntry object is invalid" )
LNERRDEF( ADDIN_ALREADY_INITIALIZED, \
	"Notes Addin has already been initialized" )
LNERRDEF( ADDIN_INVALID_LINEID, \
	"An invalid Addin Status Line ID has been passed in" )
LNERRDEF( CANNOT_DELETE_DEFAULT_STATUS_LINE, \
	"Cannot delete the default status line for this Addin" )
LNERRDEF( OBJECT_NOT_IN_LIST, "Object not in object list" )
LNERRDEF( NO_SORT_KEY, "LNSortedObjectList::AddObject requires sort key" )
LNERRDEF( OBJECT_ALREADY_IN_LIST, "Object already in object list" )
LNERRDEF( OBJECT_NOT_ON_HEAP, \
	"Object must be on heap to be added to object list" )
LNERRDEF( EXPECTED_DATA_NOT_FOUND, \
	"Expected data was not found" )
#ifdef OS390
LNERRDEF( FLOAT_OVERFLOW, \
	"Notes floating-point number is too large to convert to OS/390 format" )
#endif
LNERRDEF( UNSUPPORTED_PLATFORM, "The current platform is not supported." )


// Parameter errors codes:

LNERRDEF( NULL_POINTER_PARAMETER, \
	"Null pointer or invalid object passed to function" )
LNERRDEF( ARGUMENT_CANNOT_BE_NULL, \
	 "Argument passed to function cannot be NULL; initialize it first")
LNERRDEF( INVALID_PARAMETER, "Invalid parameter passed to function" )
LNERRDEF( PARAMETER_OUT_OF_RANGE, "Function parameter is out of range" )
LNERRDEF( SUBSCRIPT_OUT_OF_RANGE, "Array subscript is out of range" )
LNERRDEF( CLOSED_OBJECT_PARAMETER, "Object passed to function must be open" )
LNERRDEF( OBJECT_CLOSED, "Object has already been closed" )
LNERRDEF( OBJECT_NOT_INITIALIZED, "Object has not been initialized" )
LNERRDEF( UNINITIALIZED_OBJECT_PARAMETER, \
	"Uninitialized object passed to function" )
LNERRDEF( NO_NAME, "Object must have a name" )
LNERRDEF( INVALID_CONVERSION, "Couldn't perform conversion" )
LNERRDEF( NOT_INSERTABLE_TYPE, "Cannot insert this type into this object" )
LNERRDEF( OBJECT_MISMATCH, "Object is not of correct type")
LNERRDEF( OBJECT_CORRUPTED, "Object or data is corrupted" )
LNERRDEF( NULL_STRING_PARAMETER, "Null string passed to function" )
LNERRDEF( STRING_TOO_LONG, \
	"String length exceeds maximum allowed for this function" )
LNERRDEF( CANNOT_GET_STRING_SIZE, \
	"Error encountered while using LNL to determine string size" )
LNERRDEF( INVALID_UNID_STRING, "Invalid universal ID string" )


// Memory error codes:

LNERRDEF( NO_MEMORY, "Insufficient memory" )
LNERRDEF( NEED_MORE_MEMORY, \
	"The memory allocated for the output parameter is too small" )
LNERRDEF( ALREADY_ALLOCATED, \
	"Memory for this object has already been allocated" )
LNERRDEF( CANNOT_ALLOC_WHILE_DELETING, \
	"Cannot allocate memory while LNDeleteAllObjects executes" )
LNERRDEF( NOT_LNNEW_BLOCK, "LNDelete: memory block not allocated by LNNew" )
LNERRDEF( CANNOT_CREATE_MUTEX, \
	"Memory initialization error: unable to create mutex" )
LNERRDEF( CANNOT_GET_MUTEX, \
	"Memory allocation error: unable to obtain mutex" )
LNERRDEF( CANNOT_GET_TLS, \
	"Memory initialization error: unable to obtain thread-local storage" )

	
// Database error codes:

LNERRDEF( INVALID_DATABASE_NAME, "Invalid or missing database pathname" )
LNERRDEF( DATABASE_CLOSED, \
	"Unable to perform operation due to unopened database" )
LNERRDEF( WRONG_DATABASE, \
	"Specified note(s) and note array must be in the same database" )
LNERRDEF( DB_IS_DIRECTORY, "Database pathname is a directory" )
LNERRDEF( NOT_TEMPLATE_DATABASE, "Database is not a design template" )
LNERRDEF( DATABASE_ALREADY_EXISTS,
	"Cannot create database: the specified pathname already exists" )


// ACL error codes:

LNERRDEF( CANNOT_CREATE_ACL, "Cannot create ACL in new database" )
LNERRDEF( ACL_OBJECT_ALREADY_EXISTS, "Can only get one LNACL object" )
LNERRDEF( ACL_CLOSED, "ACL must be open in order to use this function" )
LNERRDEF( INVALID_ROLE_NAME_CHARACTER, "Invalid role character" )
LNERRDEF( INVALID_DEFAULT_ACL_NAME, "Cannot change default ACL entry name")


// Note and item error codes:

LNERRDEF( NOTE_ALREADY_EXISTS,"The note already exists in the database" )
LNERRDEF( CANNOT_CREATE_NOTE, "Unable to create new note" )
LNERRDEF( NOTE_CLOSED, "Unable to perform operation due to unopened note" )
LNERRDEF( CANNOT_ADD_NEW_NOTE, "Cannot add new note without saving it first" )
LNERRDEF( NOTE_MISMATCH, "Incorrect note type specified" )
LNERRDEF( CANNOT_GET_NOTE_SIZE, "Unable to calculate note size" )
LNERRDEF( NOTE_ITEM, "Function invalid for items in a note" )
LNERRDEF( UNDEFINED_ITEM, \
	"Item is uninitialized, possibly because the note containing the item has been closed" )
LNERRDEF( ITEM_ALREADY_EXISTS, "Item already exists in the note" )
LNERRDEF( ITEM_MISMATCH, "Incorrect item type specified" )
LNERRDEF( OFFSET_OUT_OF_RANGE, "Offset is beyond the range of the item" )
LNERRDEF( CANNOT_CONVERT_DATE, "Couldn't convert date or time" )
LNERRDEF( CANNOT_ADJUST_DATE, "Couldn't adjust date or time" )
LNERRDEF( SPECIAL_DATETIME,
	"This operation cannot be performed on a special date/time value" )
LNERRDEF( NOT_SUPPORTED_FOR_FT_RESULT, \
	"This operation cannot be performed on the result of a full-text search" )
LNERRDEF( NOT_NOTE_ITEM, \
	"This operation cannot be performed on an item that is not in a note" )
LNERRDEF( CANNOT_INSERT_DATETIMES, \
	"Cannot insert the specified LNDatetimes object at the specified position; use Append instead" )
LNERRDEF( ENTRY_MUST_BE_DATETIME, \
	"The LNDatetimes entry at the specified position cannot be a date/time range" )
LNERRDEF( ENTRY_MUST_BE_DATETIME_RANGE, \
	"The LNDatetimes entry at the specified position must be a date/time range" )
LNERRDEF( ITEM_NOT_FOUND, \
	"Item does not exist in the note" )
LNERRDEF( NOTE_NAME_TOO_LONG, \
	"Note name is too long or cascades too many levels" )
LNERRDEF( UNABLE_TO_CREATE_ITEM, \
    "Unable to create item in the note" ) 
LNERRDEF( UNABLE_TO_RETRIEVE_ITEM, \
    "Unable to retrieve item from the note" ) 
LNERRDEF( NOTE_MUST_HAVE_NAME, \
    "Note must have a valid name before it can be saved" )
LNERRDEF( NOTE_NAME_ENDING_BACKSLASH, \
	"Names may not end with the '\\' symbol" )


// Document and mail message error codes:

LNERRDEF( NO_MAIL_DATABASE, "Cannot locate mail database" )
LNERRDEF( INVALID_MAIL_DATABASE, \
	"Document's database is not the user's mail file" )
LNERRDEF( PARENTDB_DOESNT_MATCH, \
	"Can't make response document, parent's database doesn't match the doc's" )
LNERRDEF( SERVER_MAIL_NOTSUPPORTED, "Server mail function not supported" )
LNERRDEF( INVALID_MAIL_MESSAGE, "Invalid mail message" )
LNERRDEF( CANNOT_COPY_MAIL_MESSAGE, \
	"Prevent copying function enabled, can't copy message" )

// Events error codes
LNERRDEF(UNSUPPORTED_EVENT, "Unsupported event for design note of this type" )

// Image resource error codes:

LNERRDEF(INVALID_BMP_FORMAT, "Invalid BMP format" )
LNERRDEF(UNSUPPORTED_BMP_FORMAT, "Unsupported BMP format" )
LNERRDEF(BMP_IMAGE_NOT_SUPPORTED, \
		 "BMP image is not supported by this function on the current platform" )
LNERRDEF(IMAGE_RESOURCE_WRONG_DB, \
		 "Attempt to insert image resource from another database" )

// View/folder error codes:

LNERRDEF( INVALID_VIEW_FOLDER, "Invalid view or folder" )
LNERRDEF( INVALID_CALENDAR_VIEW_FOLDER, "Invalid calendar view or folder" )
LNERRDEF( CANNOT_INITIALIZE_VIEW_FOLDER, \
	"Error initializing view or folder data" )
LNERRDEF( EMPTY_ARRAY_PARAMETER, \
	"Empty array, view/folder, or navigator passed to function" )
LNERRDEF( VIEW_FOLDER_NOT_SAVED, \
	"View or folder must be saved before accessing entries" )
LNERRDEF( VIEW_FOLDER_CLOSED, \
	"View or folder must be open in order to use this function" )
LNERRDEF( WRONG_VIEW_FOLDER, \
	"Object is not associated with this view or folder" )
LNERRDEF( INVALID_VIEW_FOLDER_VERSION, \
	"Unsupported view or folder version" )
LNERRDEF( CANNOT_READ_VIEW_FOLDER_DESIGN, \
	"Unable to read view or folder design information" )
LNERRDEF( DESIGN_ALREADY_EXISTS, \
	"Design object already exists for this view or folder" )
LNERRDEF( NO_COLLECTION, \
	"No collection open for this view, folder, or navigator" )
LNERRDEF( TOO_MANY_KEYS, \
	"LNVFFindKeys object already has maximum number of keys" )
LNERRDEF( ITEM_TABLE_TOO_BIG, \
	"LNVFFindKeys ITEM_TABLE exceeds maximum size" )
LNERRDEF( UNREAD_NOT_SUPPORTED,
	"This operation requires the LNViewFolder::Open LNVFOPENFLAGS_USE_UNREAD_LIST flag" )
LNERRDEF( TOO_MANY_COLUMNS, "Cannot add the requested number of columns" )
LNERRDEF( NOT_SUPPORTED_FOR_SEARCH_NAVIGATOR, \
	"This operation cannot be performed on a navigator obtained using FTSearch or Find" )
LNERRDEF( CANNOT_DELETE_CATEGORY, "Cannot delete category or total entry" )
LNERRDEF( CANNOT_GET_CATEGORY, "Cannot get document for category or total entry" )
LNERRDEF( NO_ENTRIES, "No entries in this view, folder, or navigator" )
LNERRDEF( CANNOT_CREATE_VFENTRY, "Cannot create view or folder entry" )
LNERRDEF( CANNOT_DELETE_ENTRIES, \
	"Cannot delete entries that do not belong to this navigator" )
LNERRDEF( CANNOT_TRANSLATE_SPECIAL_VALUE, \
	"LNVFEntry::operator[]: cannot translate special @function value" )
LNERRDEF( CANNOT_EVALUATE_COLUMN_FORMULA, \
	"LNVFEntry::operator[]: cannot evaluate column formula" )
LNERRDEF( NIFREADENTRIES, "Unexpected NIFReadEntries failure" )
LNERRDEF( VIEW_FOLDER_NAME_TOO_LONG, \
	"View or folder name (including alias) is too long" )
LNERRDEF( VIEW_FOLDER_DUPLICATE_NAME, \
	"A view or folder with the specified name and sharing option already exists" )
LNERRDEF( NOT_FOLDER, "This operation can only be performed on a folder" )
LNERRDEF( NOT_SUPPORTED_FOR_FOLDER, \
	"This operation cannot be performed on a folder" )
LNERRDEF( NOT_CALENDAR, \
	"This operation can only be performed on a calendar view or folder" )
LNERRDEF( NOT_SUPPORTED_FOR_CALENDAR, \
	"This operation cannot be performed on a calendar view or folder" )
LNERRDEF( DESIGN_ONLY, \
	"This operation is not supported with the LNVFOPENFLAGS_DESIGN_ONLY flag" )
LNERRDEF( TIME_SLOTS_OVERLAP, "Starting and ending time slot hours overlap" )
LNERRDEF( INVALID_SECONDARY_SORT_COLUMN, \
	"Secondary sort column cannot be the current column" )
LNERRDEF( NO_SECONDARY_SORT_COLUMN_AVAILABLE, \
	"No columns available to use as secondary sort column" )
LNERRDEF( INVALID_HEADING_SORT_VIEW_FOLDER, \
	"LNVFColumn::SetHeadingSortViewFolder: cannot specify the current view or folder" )
LNERRDEF( VIEW_FOLDER_MUST_HAVE_NAME, \
	"View or folder must have a valid name before it can be saved" )
LNERRDEF( CANNOT_CHANGE_INTERNAL_NAME, \
	"Cannot change column's internal name if value is based on field name" )
LNERRDEF( CANNOT_CREATE_COLLECTION, \
	"Cannot create view or folder collection because LNVFOPENFLAGS_NO_CREATE was specified" )
LNERRDEF( TOO_MANY_FIND_KEYS, \
	"Find: number of search keys exceeds number of indexed columns" )
LNERRDEF( INVALID_FOR_NON_CATEGORIZED, "Property is invalid for non-categorized views" )
LNERRDEF( EMPTY_AUTHORS_LIST, \
		 "Non-empty Authors list should be specified if not all authors are allowed" )
LNERRDEF( EMPTY_READERS_LIST, \
		 "Non-empty Readers list should be specified if not all readers are allowed" )
	
// Form and form field error codes:

LNERRDEF( FORM_MUST_HAVE_NAME, \
	"Form must have a valid name before it can be saved" )
LNERRDEF( FORM_CLOSED, "Unable to perform operation due to unopened form" )
LNERRDEF( FORM_NAME_TOO_LONG, \
	"Form name (including alias) is too long" )
LNERRDEF( FORM_DUPLICATE_NAME, \
	"A form with the specified name already exists" )
LNERRDEF( NOT_FORM_NOTE, "This operation can only be performed on a form, subform, or page note" )
LNERRDEF( FIELD_ALREADY_IN_FORM, \
	"A form field with this name is already a member of the form" )
LNERRDEF( INVALID_FIELD_NAME, \
	"Illegal characters in the field name" )
LNERRDEF(OBJECT_PRE_46, \
	"Object, created with Notes 4.6 and above, was edited with Notes 4.5, or lower" )
LNERRDEF(NO_CFFORMULA, \
	"No formula specified for computed field" )
LNERRDEF(FIELD_TOO_LARGE, \
	"Field is too large" )
LNERRDEF(NOT_A_CHOICES_FORMULA, \
	"Field does not contain a formula for choices" )
LNERRDEF(NOT_A_CHOICES_LIST, \
	"Field does not contain a list for choices" )
LNERRDEF(MULTIPLE_FORMS, \
	"Database contains more than one form with the specified name" )
LNERRDEF(CANNOT_RESIZE_FIELD, \
    "Field of this type does not allow to set its size" )  
LNERRDEF(CANNOT_SET_WIDTH_IN_PERCENTAGE, \
    "Field of this type does not allow to set its width in percentage" )
LNERRDEF(CANNOT_SET_DYNAMIC_HEIGHT, \
    "Field of this type does not allow to set dynamic height" ) 
LNERRDEF(CANNOT_CHANGE_FIELD_STYLE, \
    "Field of this type does not allow to change its style" )
LNERRDEF(UNANTICIPATED_FIELD_PROPERTY, \
    "Field of this type does not have specified feature" )
LNERRDEF(INVALID_LAYOUT_FIELD, \
	"Invalid field type for layout region" )

// framesets error codes