miodefns.h

Go to the documentation of this file.

/****
 * \file miodefns.h <mi32/miodefns.h>
 * \brief Header file for Mio...() functions
 *
 * NOTE:  For compatibility, this file MUST be usable in C code.  Any
 *        C++ specific features must be inside #ifdef __cplusplus/#endif
 *        blocks.  This includes default parameters.
 *        Many of our 3rd party libraries are modified to use Mio functions
 *        for file IO and must be able to include this file and some of them
 *        can't be compiled for C++
 *
 * \if NODOC
 * $Id: miodefns.h_v 1.177 2004/07/15 14:24:36 dwilliss Exp $
 *
 * $Log: miodefns.h_v $
 * Revision 1.177  2004/07/15 14:24:36  dwilliss
 * Moved a prototype to allow compalation under non-C++ conditions
 *
 * Revision 1.176  2004/03/04 18:07:10  mju
 * Change MmFree from macro to inline template function.
 *
 * Revision 1.175  2004/02/27 20:02:34  scowan
 * DO not let the include file echo the deprecated items.
 *
 * Revision 1.174  2004/02/27 19:49:37  scowan
 * Added more windows depreacted functions (Old Mio calls).
 *
 * Revision 1.173  2003/11/28 15:51:55  scowan
 * Removed unused functions.
 *
 * Revision 1.172  2003/11/27 00:29:33  scowan
 * mio unlink is now retired.
 *
 * Revision 1.171  2003/11/12 20:50:49  mju
 * Add GetLastErrCode.
 *
 * Revision 1.170  2003/10/08 17:32:40  mju
 * Don't include mtimer header as confuses compiler.
 *
 * Revision 1.169  2003/10/08 16:41:02  mju
 * Move timer stuff to own header, include that header unless no_deprecated.
 * Deprecate MioUnlink.
 *
 * Revision 1.168  2003/10/06 16:19:24  scowan
 * Removed more unused flags.
 *
 * Revision 1.167  2003/10/06 16:00:31  scowan
 * Made mode functions deprecated.
 *
 * Revision 1.166  2003/10/06 14:36:06  mju
 * Remove obsolete prototypes.
 *
 * Revision 1.165  2003/09/22 15:09:34  mju
 * Move most deprecated methods to 'removed' sections.
 *
 * Revision 1.164  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.162  2003/07/09 14:36:48  mju
 * Use std name for classlibexport.
 *
 * Revision 1.161  2003/07/09 14:02:58  dwilliss
 * Don't leave CLASSLIBEXPORT defined
 *
 * Revision 1.160  2003/07/09 14:00:30  dwilliss
 * Eliminate obsolete Mac OS 9 stuff
 *
 * Revision 1.159  2003/07/03 20:37:08  scowan
 * Deprecated or removed functions.
 *
 * Revision 1.158  2003/07/03 16:48:29  mju
 * Delete many obsolete prototypes.
 *
 * Revision 1.157  2003/07/03 15:22:45  mju
 * Remove prototypes from fdspace module.
 *
 * Revision 1.156  2003/05/28 16:40:36  mju
 * Move filelistuc stuff to 'removed' section.
 *
 * Revision 1.155  2003/05/23 17:26:59  mju
 * Deprecate/remove more stuff.
 *
 * Revision 1.154  2003/05/22 16:42:25  mju
 * Deprecate GetRefFile, Rename().
 *
 * Revision 1.153  2003/05/21 22:13:54  mju
 * Move more stuff to 'removed' section.
 *
 * Revision 1.152  2003/05/20 18:00:45  mju
 * Deprecate more stuff moved to MISYSTEM.
 *
 * Revision 1.151  2003/05/16 15:27:37  mju
 * Move some deprecated stuff to 'removed' section so still export from DLL but can't use in new builds.
 *
 * Revision 1.150  2003/05/16 13:47:40  mju
 * Restore MioGetExeFile when building DLL as twmi18n uses.
 *
 * Revision 1.149  2003/05/15 14:50:20  mju
 * Remove MioGetExeFile.
 *
 * Revision 1.148  2003/05/12 16:34:47  scowan
 * Updated deprecated stuff.
 *
 * Revision 1.147  2003/05/09 17:05:10  scowan
 * More deprecated stuff.
 *
 * Revision 1.146  2003/05/09 15:43:50  scowan
 * Removed all retired functions, deprecated search list functions and structures.
 *
 * Revision 1.145  2003/05/09 14:24:59  scowan
 * Removed split path code.
 *
 * Revision 1.144  2002/09/18 17:11:06  dwilliss
 * Never mind... I was going to add a SETERRPOSNDISABLE class, but somebody
 * already created the same thing and called it ERRORPOSNDISABLE
 *
 * Revision 1.143  2002/09/09 16:35:21  mju
 * Remove builderrstr fns.
 *
 * Revision 1.142  2002/09/09 14:38:23  mju
 * Retire previously deprecated stuff.
 * Remove getdrivelist fn.
 *
 * Revision 1.141  2002/09/05 14:13:03  scowan
 * define deprecated or miodll.
 *
 * Revision 1.140  2002/07/05 14:33:02  dwilliss
 * Don't leave USEEXPORTPRAGMA defined after end of include
 *
 * Revision 1.139  2002/04/26 15:00:45  mju
 * Still need builderrstr/uc prototypes when compiling RVCSYS.
 *
 * Revision 1.138  2002/04/25 22:08:19  mju
 * Remove comment re deprecate_varargs from log.
 *
 * Revision 1.137  2002/04/25 21:48:26  mju
 * Retire builderrstr.
 *
 * Revision 1.136  2002/04/05 15:09:32  mju
 * Retire BuildErrstrUCV except when compiling MISYSTEM or RVCSYS DLLs.
 *
 * Revision 1.131  2002/03/27 16:36:34  mju
 * Deprecate varargs in ErrStr stuff.
 * Add GetErrString().
 *
 * Revision 1.130  2002/03/01 20:15:20  dwilliss
 * MioGetMacFileType prototype should be defined for MacOS X too
 *
 * Revision 1.129  2002/01/14 17:30:04  mju
 * Remove Get/SetModuleFilename functions.
 *
 * Revision 1.127  2001/12/11 00:13:52  scowan
 * Deprecated more mio functions that deal with file paths.
 *
 * Revision 1.126  2001/12/06 20:46:19  scowan
 * Moved long list of functions to DEPRECATED status and one function to RETIRED status.
 * Removed pseudo RETIRED status functions (FILESIZE64) outright.
 *
 * Revision 1.125  2001/11/26 22:01:16  dwilliss
 * heapsort fix for Mac OS X
 *
 * Revision 1.124  2001/10/03 20:07:58  dwilliss
 * Damn it! Don't add default parameters to a funcion without also adding
 * an #ifdef __cplusplus and a prototype without the defaults if it's not
 * C++.  We DO still have non-C++ code!
 *
 * Revision 1.123  2001/10/02 16:09:06  mju
 * Add defaults for filter func/data for MioCopyFile.
 *
 * Revision 1.121  2001/09/12 19:15:44  scowan
 * Added is running win 2000.
 *
 * Revision 1.120  2001/06/22 20:37:58  mju
 * Use const in MioMakeDir and MioMakePathDirs.
 *
 * Revision 1.119  2001/05/23 22:43:24  scowan
 * Added class to disable and re-enable error position reporting.
 *
 * Revision 1.118  2001/05/16 17:49:07  dwilliss
 * Put major warning at the top of the file.
 *
 * Revision 1.117  2001/05/14 17:26:07  dwilliss
 * Default paramerters MUST be included ONLY if __cplusplus is defined
 * XmHTML includes this and can't be compiled for C++
 *
 * Revision 1.116  2001/05/14 14:03:00  mju
 * Add defaults and comments for Mio Seek64.
 *
 * Revision 1.115  2001/05/04 19:58:55  scowan
 * Added more const and new platform.
 *
 * Revision 1.114  2001/03/01 16:37:48  scowan
 * Change list name to alist for std namespace.
 *
 * Revision 1.1  1994/08/03  22:39:33  scowan
 * Initial revision
 * \endif
****/

#ifndef  INC_MI32_MIODEFNS_H
#define  INC_MI32_MIODEFNS_H

#ifndef  INC_STDARG_H
#include <stdarg.h>
#define  INC_STDARG_H
#endif

#ifndef  INC_STDIO_H
#include <stdio.h>
#define  INC_STDIO_H
#endif

#ifndef  INC_STDLIB_H
#include <stdlib.h>        //! for void free(void*)
#define  INC_STDLIB_H
#endif

#ifndef  INC_MI32_STDDEFNS_H
#include <mi32/stddefns.h>
#endif

#ifdef MISYSTEMDLL
   #define LIBEXPORT MI_DLLEXPORT
   #define CLASSLIBEXPORT MI_DLLCLASSEXPORT
#else
   #define LIBEXPORT MI_DLLIMPORT
   #define CLASSLIBEXPORT MI_DLLCLASSIMPORT
#endif


#ifdef WIN32
#pragma warning (disable:4996)
#endif

#ifdef   __cplusplus
class MISTRING;
#endif

#define  MioFLAG_OBCFileName        0x00000080     //!<  Was OneByteChar flag, now removed 

#if defined(__cplusplus)
extern "C" {
#endif


//!:Associate with "Error Reporting Functions"
//!\addtogroup ErrorPosn Error Reporting Functions
//!@{

//! Clear the last reported error and the error stack.
LIBEXPORT void ClearLastErr (void);

//! Get the details string set by SetErrDetails().
//! Do not free the returned string.
LIBEXPORT const UNICODE* GetErrDetails ();

#if defined(__cplusplus) 

//! Get MISTRING reference to current error message.
//! This allows subsequent use of the << operator on the string to substitute
//! or append additional error values for %-format or $-position codes.
LIBEXPORT MISTRING& GetErrString (
   );

//! Get the last error message (Unicode).
//! Do not free the returned string.
LIBEXPORT const UNICODE* GetErrStrUC (
   ERRVALUE errcode,                   //!< Error code to retrieve string for
   int *errlevel = 0                   //!< Error level returned (NULL if don't care)
   );


//! Get the first line of the last error message (Unicode).
//! Do not free the returned string.
LIBEXPORT const UNICODE* GetErrStrLine1UC (
   ERRVALUE errcode,                   //!< Error code to retrieve string for
   int *errlevel = 0                   //!< Error level returned (NULL if don't care)
   );

//! Determine if error position recording is disabled.
//! @return true if disabled, false if not.
LIBEXPORT bool IsErrPosnDisabled ();

#else
#ifndef GENERATING_DOXYGEN_OUTPUT
//! Version of above without default parameter for 3rd party libs
//! that don't compile with C++ but that we still have to patch
//! to use Mio

LIBEXPORT const UNICODE* GetErrStrUC (
   ERRVALUE errcode,                   //!< Error code to retrieve string for
   int *errlevel                       //!< Error level returned (NULL if don't care)
   );

LIBEXPORT const UNICODE* GetErrStrLine1UC (
   ERRVALUE errcode,                   //!< Error code to retrieve string for
   int *errlevel                       //!< Error level returned (NULL if don't care)
   );

#endif // GENERATING_DOXYGEN_OUTPUT
#endif

//! Get last error code.
LIBEXPORT ERRVALUE GetLastErrCode ();

//! Set the details string for an error.  
//! This can be used to report any extra details about an error.
//! If set, the standard error dialog will have a "detial..." button
//! which will let the user see the details.
LIBEXPORT void SetErrDetails (
   const UNICODE*
   );

#ifndef GENERATING_DOXYGEN_OUTPUT
LIBEXPORT   int         _SetErrPosn (int, const char*, int);
LIBEXPORT   int         _SetErrPosnC (int, const char*, int);
#endif // GENERATING_DOXYGEN_OUTPUT

//! Record an error code and it's position.
//!
//! Note, this is really a macro which calls an internal function
//! and also passes it RCSID and __LINE__
//! For this to work, the following line must exist near the top
//! of the module (just below the main comment block)
//! @code
//!    #define RCSID "@(#)$Id: miodefns.h_v 1.177 2004/07/15 14:24:36 dwilliss Exp $"
//! @endcode
//!
//! Note: The example above shows what the RCSID for this include file looks
//! like. If you're using RCS, it will fill in everything between the <tt>Id:</tt> and the <tt>$</tt>.  If you're not using RCS, change miodefns.h to the name
//! of the source module.  The number after that is the revision number which
//! TNT will show in the error message.  The rest of the RCSID is ignored.
#define  SetErrPosn(e)  _SetErrPosn(e,RCSID,__LINE__)

//! Clear current error stack and set error position.
//!
//! Same as SetErrPosn(), but clears the error stack first.
//!
//! @see SetErrPosn()
#define  SetErrPosnC(e) _SetErrPosnC(e,RCSID,__LINE__)


//! Set the current error position and goto Error label.
//!
//! Note, This is really a #define macro.
//!
//! It does the same thing as SetErrPosn(), then does a 
//! <tt>goto Error;</tt> 
#define  SetErrPosnGoto(e)    { err=SetErrPosn(e); goto Error; }

//! Clear the error stack, set the current error position and goto Error label.
//!
//! Note, This is really a #define macro.
//! It does the same thing as SetErrPosnC(), then does a 
//! <tt>goto Error;</tt> 
#define  SetErrPosnGotoC(e)   { err=SetErrPosnC(e); goto Error; }


//! Disable error position reporting.
//!
//! This is important when cleaning up after an error.  It often happens that
//! if you get an error, you need to cleanup (close files, etc) before returning.
//! If something in your cleanup code also causes an error, it will wipe out
//! the error trace that you're trying to report.  Therefore, always bracket
//! cleanup code with SetErrPosnDiaable()/SetErrPosnEnable().
LIBEXPORT void SetErrPosnDisable (void);

//! Reenable error position reporting.
//!
//! @see SetErrPosnDisable()
LIBEXPORT void SetErrPosnEnable (void);

//!@}

#if defined(__cplusplus)
//! Disable and enable error positioning using this class and scoping

class ERRORPOSNDISABLE {
   public:
      ERRORPOSNDISABLE (
         ) { SetErrPosnDisable(); }
      
      ~ERRORPOSNDISABLE (
         ) { SetErrPosnEnable(); }
   };

#endif


#ifdef MAC_OSX
//! Mac OSX standard library defines their own heapsort which takes a
//! different compare function.  This makes sure we link to ours, not
//! theirs.
#define heapsort heapsort_MicroImages
#endif

//!:Associate with "Sorting Functions"
//!\addtogroup sort Sorting Functions
//!@{

//! Memory based heapsort.
//!
//! Sorts an array in memory.  Assumes it can use memcpy() to swap items.
LIBEXPORT void heapsort (
   void* array,                        //!< Array to sort 
   INT32 n,                            //!< Number of elements in array
   INT32 size,                         //!< sizeof() each element
   int (*compare)(void*a, void*b, void*hookdata),  //! Compare function. Return 1 if *a <= *b.
   void* hookdata                      //!< Passed as 3rd parameter to compare function
   );

//! Generic Heapsort.
LIBEXPORT int HeapSortGen (
   INT32 n,                            //!< Number of items to sort
   int (*compare)(INT32 a, INT32 b, void* hookdata),  //! Return 1 if item a <= item b
   int (*swap)(INT32 a, INT32 b, void* hookdata),     //! Swap two items
   void* hookdata                      //!< Passed as 3rd parameter to compare and swap functions
   );
//!@}


//!:Associate with "Math Functions"
//!\addtogroup math Math Functions
//!@{

//! Returns the IEEE representation of Not A Number.
LIBEXPORT   double      IEEE_NaN (void);

//! Returns the IEEE representation of Infinity.
LIBEXPORT   double      IEEE_Infinity (void);

//!@}

//!:Associate with "Mm Functions (Memory Allocation)"
//!\addtogroup Mm Memory Allocation Functions (Mm)
//!@{

/*
*  The following macro changed 19-Nov-96 DCW.  The do -- while (0) looks silly but the body will be executed exactly 
*  once.  The compiler will optimize out the fact that it looks like a loop.  The advantage is that you can always put 
*  a ';' after it, even if the next thing after it is an "else".  
*
*/
//! Free a pointer and set it's value to NULL.
#if defined(__cplusplus)
}
template <class _CT> inline void MmFree(_CT *& p) { if (p != 0) { free(p); p = NULL; } }
extern "C" {
#else
#define  MmFree(p)      do {if ((p) != NULL) {free((p));(p) = NULL;}} while (0)
#endif

//! Allocate memory - Return error on failure.
//!
//! Returns error code if allocation fails.
//! Example:
//! @code
//!    UINT8* buf;
//!    err = MmAlloc((void**)&buf, size);
//!    if (err < 0) return(SetErrPosn(err));
LIBEXPORT ERRVALUE MmAlloc (
   void** ptr,                         //!< Pointer to memory allocated and returned
   int size                            //!< Size to allocate in bytes
   );

//! Allocate and clear memory - Return error on failure.
//!
//! @see MmAlloc()
LIBEXPORT ERRVALUE MmAllocC (
   void** ptr,                         //!< Pointer to memory allocated and returned
   int size                            //!< Size to allocate in bytes
   );

//! Allocate and clear memory - Throw exception of failure.
//!
//! @see MmAlloc()
LIBEXPORT void MmAllocCExc (
   void** ptr,                         //!< Pointer to memory allocated and returned
   int size                            //!< Size to allocate in bytes
   );

//! Allocate memory - Throw exception of failure.
//!
//! @see MmAlloc()
LIBEXPORT void MmAllocExc (
   void** ptr,                         //!< Pointer to memory allocated and returned
   int size                            //!< Size to allocate in bytes
   );

//! Resize memory buffer, retaining existing contents - Return error on failure.
//!
//! @see MmAlloc()
LIBEXPORT ERRVALUE MmRealloc (
   void** ptr,                         //!< Pointer to memory to reallocate and returned
   int newsize                         //!< New size in bytes
   );

#if defined(__cplusplus)
//! Resize memory buffer and clear new part - Return error on failure.
//!
//! @see MmAlloc()
LIBEXPORT ERRVALUE MmReallocC (
   void** ptr,                         //!< Pointer to memory to reallocate and returned
   int newsize,                        //!< New size in bytes
   int oldsize = 0                     //!< Size of portion to not clear in bytes
   );
#else //!<  normal "C" 
LIBEXPORT ERRVALUE MmReallocC (
   void** ptr,                         //!< Pointer to memory to reallocate and returned
   int newsize,                        //!< New size in bytes
   int oldsize                   //!< Size of portion to not clear in bytes
   );
#endif

#if defined(__cplusplus)
//! Resize memory buffer and clear new part - Throw exception on failure.
//!
//! @see MmAlloc()
LIBEXPORT void MmReallocCExc (
   void** ptr,                         //!< Pointer to memory to reallocate and returned
   int newsize,                        //!< New size in bytes
   int oldsize = 0                     //!< Size of portion to not clear in bytes
   );
#endif

#if defined(__cplusplus)
//! Resize memory buffer, discarding existing contents - Return error on failure.
//!
//! @see MmAlloc()
inline ERRVALUE MmReallocD (
   void** ptr,                         //!< Pointer to memory to reallocate and returned
   int newsize                         //!< New size in bytes
   ) {
   if (*ptr != 0) {
      free(*ptr);
      }
   return (MmAlloc(ptr,newsize));
   }
#endif

#if defined(__cplusplus)
//! Resize memory buffer, discarding existing contents - Throw exception on failure.
//!
//! @see MmAlloc()
inline void MmReallocDExc (
   void** ptr,                         //!< Pointer to memory to reallocate and returned
   int newsize                         //!< New size in bytes
   ) {
   if (*ptr != 0) {
      free(*ptr);
      }
   MmAllocExc(ptr,newsize);
   return;
   }
#endif

#if defined(__cplusplus)
//! Resize memory buffer, retaining existing contents - Throw exception on failure.
//!
//! @see MmAlloc()
LIBEXPORT void MmReallocExc (
   void** ptr,                         //!< Pointer to memory to reallocate and returned
   int newsize                         //!< New size in bytes
   );
#endif

//!@}

//!:Associate with "Mio (File I/O and system) functions"
//!\addtogroup Mio File I/O and system functions (Mio)
//!@{

//! Close a file.
//! \deprecated Replaced by FILE_RAW::Close();
DEPRECATED LIBEXPORT int MioClose (
   int handle                          //!< Handle to open file
   );

//! Get size of an open file.
//! \deprecated Replaced by FILE_RAW::GetSize();
//!
//! @return Size of open file.
//!
//!   Made long instead of INT32 intentionally.
//!   This function is needed because the Mac does not have a fstat().
DEPRECATED LIBEXPORT long MioGetOpenFileSize (
   int handle                          //!< Open file descriptor
   );          

//! Get size of an open file.
//! \deprecated Replaced by FILE_RAW::GetSize();
//!
//! @return Size of open file.
DEPRECATED LIBEXPORT INT64 MioGetOpenFileSize64 (
   int handle
   );

//! Get size of an open file pointer (FILE *).
//!
//! @return Size of open file.
//! 
//! Made long instead of INT32 intentionally.
//! This function is needed because the Mac does not have a fstat().
LIBEXPORT long MioGetOpenFPSize (
   FILE *fp                            //!< Open FILE pointer
   );             

//! Read a string from a file created on ANY platform.
//!
//! @return Length read, error code or -1 if EOF.
//!
//!   This function reads a line of text file up to the 'newline' character
//!   or (len - 1), whichever is first.  The 'newline' character is handled
//!   irregardless of the platform run on and the platform that created the
//!   text file.  The 'newline' charact is NOT appended onto the string.
//!   If this function gets to the 'end of file', -1 is returned.  The
//!   length of the string should be 'len + 1' for reading in the string
//!   and a place for the string terminator.  This behavior is the same as fgets().
LIBEXPORT INT32 MioGetStr (
   char *str,                          //!< String to read into
   INT32 len,                          //!< Maximum length to read - 1
   FILE *f                             //!< File handle
   );


#ifdef   __cplusplus

//! Open an existing file.
//!
//! Return value depends on whether 'fp' is NULL.  If it is, this function
//!   uses open() to open the file and determines open mode based on the mode
//!   string.  The handle is in the return value.  Acceptable modes are shown below:
//!
//!   Modes and equivalent:      
//!      "r"      Read-only      
//!      "r+"     Read-write
//!      "w"      New file (no CR/LF translation)     
//!   "wt"     New file (with CR/LF translation)
//!
//!   If 'fp' is not NULL, fopen() is used to open the file and the return value
//!   is 0 if fopen was sucessful, otherwise an error is returned.
//!   The flag is called MioFLAG_NoBuildErrStr.  MioOpen will not build
//!   an error string if this flag is specified.  Used in FindErrStr() in  geterrst.c.
LIBEXPORT int MioOpen (
   const UNICODE *filename,            //!< File to open
   const char *mode,                   //!< fopen() type mode string
   FILE **fp = 0,                      //!< File pointer RETURNED, can be NULL
   UINT32 flag = 0                     //!< Flag
   );

#else

//! Open an existing file.
//!
//! Return value depends on whether 'fp' is NULL.  If it is, this function
//!   uses open() to open the file and determines open mode based on the mode
//!   string.  The handle is in the return value.  Acceptable modes are shown below:
//!
//!   Modes and equivalent:      
//!      "r"      Read-only      
//!      "r+"     Read-write
//!      "w"      New file (no CR/LF translation)     
//!   "wt"     New file (with CR/LF translation)
//!
//!   If 'fp' is not NULL, fopen() is used to open the file and the return value
//!   is 0 if fopen was sucessful, otherwise an error is returned.
//!   The flag is called MioFLAG_NoBuildErrStr.  MioOpen will not build
//!   an error string if this flag is specified.  Used in FindErrStr() in  geterrst.c.
LIBEXPORT int MioOpen (
   const UNICODE *filename,            //!< File to open
   const char *mode,                   //!< fopen() type mode string
   FILE **fp,                          //!< File pointer RETURNED, can be NULL
   UINT32 flag                         //!< Flag
   );

#endif

//! Read from an open file.
//! \deprecated Replaced by FILE_RAW::Read();
//!
//! @return "Size" or error code.
//!
//! If less than number of requested bytes are read, EDiskReadErr will be returned.
DEPRECATED LIBEXPORT INT32 MioRead (
   int handle,                         //!< Handle from MioOpen()
   void *data,                         //!< Buffer to contain data read
   INT32 size                          //!< Number of bytes to read
   );

//! Seek to a position within an open file.
//! \deprecated Replaced by FILE_RAW::Seek();
//!
//! @return New position in the file.
DEPRECATED LIBEXPORT INT32 MioSeek (
   int handle,                         //!< Open file handle from MioOpen().
   INT32 offset,                       //!< Where to seek to
   int type                            //!< SEEK_CUR, SEEK_SET, SEEK_END
   );

//! Seek to a spot and read the data.
//! \deprecated Replaced by FILE_RAW::SeekAndRead();
//!
//! @return NOTE: This function returns an error if < size is read in.
DEPRECATED LIBEXPORT INT32 MioSeekAndRead (
   int handle,                         //!< Open file handle from MioOpen().
   long offset,                        //!< Where to seek to (SEEK_SET)
   void *data,                         //!< Buffer to read into
   INT32 size                          //!< Amount to read in bytes
   );

//! Seek to a spot and write the data.
//! \deprecated Replaced by FILE_RAW::SeekAndWrite();
//!
//! @return Amount read or error code if < 0.
//!
//! NOTE: This function returns an error if < size is written out.
DEPRECATED LIBEXPORT INT32 MioSeekAndWrite (
   int handle,                         //!< Open file handle from MioOpen().
   long offset,                        //!< Where to seek to (SEEK_SET)
   const void*const data,              //!< The data to write from
   INT32 size                          //!< Amount to read in bytes
   );

#if defined(__cplusplus)
//! Current position in the file (macro).
//! @return Position in the file or error.
inline INT32 MioTell (
   int handle                          //!< Open file handle from MioOpen().
   ) { return (MioSeek(handle, 0, SEEK_CUR)); }
#else
#define  MioTell(h)     MioSeek((h), 0, SEEK_CUR)
#endif

//! Write to an open file.
//! \deprecated Replaced by FILE_RAW::Write();
//!
//! @return "Size" or error code.
//!
//! If the OPSYS write() call writes less than requested, EDiskWriteErr will
//!   be returned.
DEPRECATED LIBEXPORT INT32 MioWrite (
   int handle,                         //!< Handle from MioOpen()
   const void*const data,              //!< The data to write from
   INT32 size                          //!< The amount to write
   );

//=====================================================================================================================
//    DEPRECATED - Begin

#if !defined(NO_DEPRECATED) || defined(MISYSTEMDLL)

#endif   // Deprecated items

//!@}

//    DEPRECATED - End
//=====================================================================================================================
//    RETIRED - Begin

#if defined(ALLOW_RETIRED) || defined(MISYSTEMDLL)

//! Search for a specific reference file.
//! \deprecated Replaced by FILEFIND::LocateReferenceFile()
//!
//! @return Complete path to the file or NULL if not found.
//!
//! Flag values:
//!      MioFLAG_OBCFileName  Use one-byte-character (ASCII) filename for searching
//!      MioFLAG_UseHomePath  Prefix users home directory if it exists to the search path
//!      MioFLAG_UseLocale    Add TNTmips locale directories to the search
LIBEXPORT UNICODE *MioGetRefFile (
   const void *vname,                  //!< File or path/file to search for, default is UNICODE string
   UINT32 flags                        //!< Flags
   );

#endif   // Retired items

//    RETIRED - End
//=====================================================================================================================
//    REMOVED - Begin

#ifndef GENERATING_DOXYGEN_OUTPUT
//! Removed items, still exported from DLL until sure all dependent EXEs rebuilt.

#endif // GENERATING_DOXYGEN_OUTPUT

//    REMOVED - End
//=====================================================================================================================


#if defined(__cplusplus)
}                       
#endif

#ifdef WIN32
#pragma warning (default:4996)
#endif

#undef LIBEXPORT
#undef CLASSLIBEXPORT

#endif   //!<  INC_MI32_MIODEFNS_H 

---