XBinder  Version 2.9.x
rtxFile.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2003-2022 Objective Systems, Inc.
3  *
4  * This software is furnished under a license and may be used and copied
5  * only in accordance with the terms of such license and with the
6  * inclusion of the above copyright notice. This software or any other
7  * copies thereof may not be provided or otherwise made available to any
8  * other person. No title to and ownership of the software is hereby
9  * transferred.
10  *
11  * The information in this software is subject to change without notice
12  * and should not be construed as a commitment by Objective Systems, Inc.
13  *
14  * PROPRIETARY NOTICE
15  *
16  * This software is an unpublished work subject to a confidentiality agreement
17  * and is protected by copyright and trade secret law. Unauthorized copying,
18  * redistribution or other use of this work is prohibited.
19  *
20  * The above notice of copyright on this source code product does not indicate
21  * any actual or intended publication of such source code.
22  *
23  *****************************************************************************/
28 #ifndef _RTXFILE_H_
29 #define _RTXFILE_H_
30 
31 #include "rtxsrc/rtxContext.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
44 EXTERNRT OSBOOL rtxFileExists (const char* filePath);
45 
46 #ifndef OMNITRACS_RT
47 
55 EXTERNRT OSBOOL rtxFileIsDirectory (const char* filePath);
56 #endif
57 
58 #ifndef ARC_DSP
59 
63 EXTERNRT time_t rtxFileLastModified( const char* filePath );
64 #endif
65 
78 EXTERNRT int rtxFileOpen
79 (FILE** ppFile, const char* filePath, const char* access);
80 
96 EXTERNRT int rtxFileReadBinary
97 (OSCTXT* pctxt, const char* filePath, OSOCTET** ppMsgBuf, size_t* pLength);
98 
114 EXTERNRT int rtxFileReadBinary2
115 (OSCTXT* pctxt, FILE* pFile, OSOCTET** ppMsgBuf, size_t* pLength);
116 
132 EXTERNRT int rtxFileReadBinToSysMem
133 (OSCTXT* pctxt, const char* filePath, OSOCTET** ppMsgBuf, size_t* pLength);
134 
153 EXTERNRT int rtxFileReadText
154 (OSCTXT* pctxt, const char* filePath, OSOCTET** ppMsgBuf, size_t* pLength);
155 
166 EXTERNRT int rtxFileWriteBinary
167 (const char* filePath, const OSOCTET* pMsgBuf, size_t length);
168 
180 EXTERNRT int rtxFileWriteText
181 (const char* filePath, const char* pMsgBuf);
182 
193 EXTERNRT int rtxFileCopyTextFile
194 (const char* srcFilePath, const char* destFilePath);
195 
196 #ifdef __cplusplus
197 }
198 #endif
199 
200 #endif
rtxFileCopyTextFile
EXTERNRT int rtxFileCopyTextFile(const char *srcFilePath, const char *destFilePath)
This function copies the contents on one text file to another.
rtxFileReadBinary
EXTERNRT int rtxFileReadBinary(OSCTXT *pctxt, const char *filePath, OSOCTET **ppMsgBuf, size_t *pLength)
This function reads the entire contents of a binary file into memory.
rtxFileWriteBinary
EXTERNRT int rtxFileWriteBinary(const char *filePath, const OSOCTET *pMsgBuf, size_t length)
This function writes binary data from memory to the given file.
rtxFileExists
EXTERNRT OSBOOL rtxFileExists(const char *filePath)
This function tests if a file exists.
rtxContext.h
Common run-time context definitions.
rtxFileIsDirectory
EXTERNRT OSBOOL rtxFileIsDirectory(const char *filePath)
This function tests if a file is actually a directory.
rtxFileReadBinary2
EXTERNRT int rtxFileReadBinary2(OSCTXT *pctxt, FILE *pFile, OSOCTET **ppMsgBuf, size_t *pLength)
This function reads the entire contents of a binary file into memory.
rtxFileOpen
EXTERNRT int rtxFileOpen(FILE **ppFile, const char *filePath, const char *access)
This function opens a file for read, write, or append access.
rtxFileLastModified
EXTERNRT time_t rtxFileLastModified(const char *filePath)
This function returns the last modified time for a given file.
rtxFileReadText
EXTERNRT int rtxFileReadText(OSCTXT *pctxt, const char *filePath, OSOCTET **ppMsgBuf, size_t *pLength)
This function reads the entire contents of an ASCII text file into memory.
rtxFileWriteText
EXTERNRT int rtxFileWriteText(const char *filePath, const char *pMsgBuf)
This function writes text data from memory to the given file.
rtxFileReadBinToSysMem
EXTERNRT int rtxFileReadBinToSysMem(OSCTXT *pctxt, const char *filePath, OSOCTET **ppMsgBuf, size_t *pLength)
This function reads the entire contents of a binary file into memory.
OSCTXT
Run-time context structure.
Definition: rtxContext.h:198