// FVSDK_ErrorCodes.h : header file FTP Voyager Software Development Kit error values
//
// Copyright © 1997-2008 - Rhino Software, Inc.
// FTP Voyager® is a registered trademark of Rhino Software, Inc.
// http://www.RhinoSoft.com/
//
// Author: Mark P. Peterson
// Date: August 19, 2005
//
// You are free to use/modify this code but leave this header intact.
// FTP Voyager, the FTP Voyager Software Development Kit, and FtpTree ActiveX
// Control are not public domain. Any registration IDs or non-public domain
// software from Rhino Software, Inc. remains copyrighted. For more information
// refer to the license agreement distributed with the FTP Voyager SDK.
//
// If you decide to use the FTP Voyager Software Development Kit, or FtpTree
// ActiveX control, you must first purchase a license. For more information
// visit http://www.RhinoSoft.com/
//------------------------------------------------------------------------------
// prevent multiple inclusions of this file
#ifndef _FVSDK_ErrorCodes_HEADER
#define _FVSDK_ErrorCodes_HEADER
#include <time.h>
#include "FtpTreeErrors.h" // error codes from FtpTree ActiveX Control
/////////////////////////////////////////////////////////////////////////////
// typedefs
typedef int FVSDK_ERROR_CODE;
typedef struct tm FVSDK_TIME;
/////////////////////////////////////////////////////////////////////////////
// error codes
/*** FVSDK_ERROR_CODE Constants ***/
#define FVSDK_YES FVSDK_OK // representation of TRUE or yes for boolean style operations
// constants
const FVSDK_ERROR_CODE FVSDK_NO = 0; // representation of FALSE or no for boolean style operations
const FVSDK_ERROR_CODE FVSDK_OK = 1; // operation was completed successfully, there was no error
const FVSDK_ERROR_CODE FVSDK_INVALID_PARAMETER = 2; // an invalid parameter was passed to the function
const FVSDK_ERROR_CODE FVSDK_INVALID_SESSION_SIZE = 3; // the session size (nSize) is incorrect, please check your FVSDK_Session definition or header file
const FVSDK_ERROR_CODE FVSDK_INVALID_SESSION_VERSION = 4; // the session version number (nVersion) is not FVSDK_SESSION_CURRENT_VERSION, please check your FVSDK_Session definition or header file
const FVSDK_ERROR_CODE FVSDK_MAXIMUM_NUMBER_SESSIONS = 5; // the maximum number of concurrent sessions supported by the FTP Voyager SDK is USHRT_MAX (0xffff or 65,535), this has been exceeded
const FVSDK_ERROR_CODE FVSDK_UNABLE_TO_ALLOCATE_MEMORY = 6; // serious program error where the FTP Voyager SDK was unable to allocate the required memory for an operation
const FVSDK_ERROR_CODE FVSDK_UNABLE_ADD_TO_SESSION_MAP = 7; // serious program error where the FTP Voyager SDK was unable to map or save the session being passed.
const FVSDK_ERROR_CODE FVSDK_UNABLE_TO_FIND_MAPPED_SESSION = 8; // the session used as a parameter to a function was not found in the internal FTP Voyager SDK maps, this is usually due to either FVSDK_InitSession() or FVSDK_NewSession() not being called for a FVSDK_Session structure
const FVSDK_ERROR_CODE FVSDK_UNABLE_TO_CONNECT = 9; // the FTP Voyager SDK was unable to connect to the requested server
const FVSDK_ERROR_CODE FVSDK_UNABLE_TO_CREATE_FTPTREE = 10; // the internal FtpTree ActiveX control for the session could not be created, this is usually due to an improper installation of FtpTree ActiveX control on the target computer, please read the "Deploying" section of the FVSDK manual for detailed information
const FVSDK_ERROR_CODE FVSDK_UNABLE_TO_CREATE_FTPTREE_CONTAINER_WINDOW = 11; // the container Window used to contain the FtpTree ActiveX control (a hidden window) could not be created, this indicates a serious Windows problem
const FVSDK_ERROR_CODE FVSDK_INVALID_FTPTREE = 12; // the internal allocation of FtpTree appears to be invalid, ensure that the session is connected prior to using this function
const FVSDK_ERROR_CODE FVSDK_NOT_CONNECTED = 13; // the operation requires a connected session, connect to a server before performing this operation
const FVSDK_ERROR_CODE FVSDK_BUSY = 14; // FTP Voyager SDK is currently busy performing another operation, either stop the current operation, or wait until the operation is complete
const FVSDK_ERROR_CODE FVSDK_FILE_NAME_CANNOT_BE_FULL_PATH = 15; // the file name, passed as a parameter, can only be a file name or wild card, it cannot contain path information. Use FVSDK_SetCurrentDirectory() to change to the desired directory.
const FVSDK_ERROR_CODE FVSDK_INVALID_FILE_INFO_SIZE = 16; // the file info size (nSize) is incorrect, please check your FVSDK_FileInfo definition or header file
const FVSDK_ERROR_CODE FVSDK_INVALID_FILE_INFO_VERSION = 17; // the file info version number (nVersion) is not FVSDK_FILE_INFO_CURRENT_VERSION, please check your FVSDK_FileInfo definition or header file
const FVSDK_ERROR_CODE FVSDK_TRANSFER_STATUS_NOT_FOUND = 18; // the specified transfer status was not found
// intentional gap
// registration errors
const FVSDK_ERROR_CODE FVSDK_INVALID_REGISTRATION_ID = 100; // the registration ID being used is invalid, visit http://www.RhinoSoft.com/sales for assistance
const FVSDK_ERROR_CODE FVSDK_EXPIRED_REGISTRATION_ID = 101; // the registration ID being used is not valid for this version, visit http://www.RhinoSoft.com/sales for assistance
const FVSDK_ERROR_CODE FVSDK_EXPIRED_TEMP_REGISTRATION_ID = 103; // the temporary registration ID is expired, visit http://www.RhinoSoft.com/sales for assistance
const FVSDK_ERROR_CODE FVSDK_EXPIRED_TRIAL = 104; // the trial period for the FTP Voyager Software Development Kit is expired, visit http://www.RhinoSoft.com/sales for assistance
/*** END FVSDK_ERROR_CODE ***/
/////////////////////////////////////////////////////////////////////////////
#endif