mirror of https://github.com/Gnucash/gnucash
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
58 lines
2.9 KiB
58 lines
2.9 KiB
/********************************************************************\
|
|
* FileIOP.h -- private header to read from and writing to a *
|
|
* datafile for gnucash (X-Accountant) *
|
|
* Copyright (C) 1997 Robin D. Clark *
|
|
* Copyright (C) 1998, 1999 Linas Vepstas *
|
|
* *
|
|
* This program is free software; you can redistribute it and/or *
|
|
* modify it under the terms of the GNU General Public License as *
|
|
* published by the Free Software Foundation; either version 2 of *
|
|
* the License, or (at your option) any later version. *
|
|
* *
|
|
* This program is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License*
|
|
* along with this program; if not, write to the Free Software *
|
|
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
|
|
\********************************************************************/
|
|
|
|
#ifndef __XACC_FILEIO_P_H__
|
|
#define __XACC_FILEIO_P_H__
|
|
|
|
#include "Group.h"
|
|
|
|
/** PROTOTYPES ******************************************************/
|
|
/*
|
|
* NOTE:
|
|
* The Read and WriteAccountGroupFile routines should not be used directly.
|
|
* They are not "safe" against file-locking errors. Use the Session
|
|
* object instead.
|
|
*
|
|
* These routines are implemented on top of the public xaccReadAccountGroup()
|
|
* and xaccWriteAccountGroup() routines.
|
|
*
|
|
* The xaccReadAccountGroupFile() method will open and read the indicated
|
|
* filename. It is expected that the file stores an "xac" format
|
|
* gnucash data file. It will return the contents of the file,
|
|
* transcribed as an AccountGroup data structure. If a read error
|
|
* occurred during reading, the returned value may or may not be
|
|
* null. Use the xaccGetFileIOError() routine to check for read
|
|
* errors.
|
|
*
|
|
* The xaccWriteAccountGroupFile() method will open the indicated
|
|
* file and write the indicated account group to it, in the
|
|
* gnucash "xac" format. It will also write out a time-stamped
|
|
* copy of the file into the same directory as the indicated file,
|
|
* with a filename of "file.YYYYMMDDHHMMSS.xac" where YYYYMMDDHHMMSS
|
|
* is replaced with the current year/month/day/hour/minute/second.
|
|
* Returns a negative number if an error occured.
|
|
*/
|
|
AccountGroup *xaccReadAccountGroupFile (const char *datafile);
|
|
int xaccWriteAccountGroupFile (const char *datafile,
|
|
AccountGroup *grp);
|
|
|
|
#endif /* __XACC_FILEIO_P_H__ */
|