PFile API functions


Detailed Description

Portable file API.

Must call pmemInit() before using this module. If threads are to be used, ptrdInit() must be called before using this module as well.

NOTE: It is technically impossible to provide a cross-platform version of scanf() and its variants (since vscanf() does not exist). As a result, this module does not provide this functionality. End-users are encourages to do their own parsing.


Defines

#define USE_LIGHT_WEIGHT_PANSI_FILE_WRAPPERS   1
#define PEOF   EOF

Typedefs

typedef FILE PFile

Functions

PORTABLE_API PFilepfopen (const LCHAR *filename, const LCHAR *mode)
PORTABLE_API size_t pfread (void *buffer, size_t size, size_t count, PFile *stream)
PORTABLE_API size_t pfwrite (void *buffer, size_t size, size_t count, PFile *stream)
PORTABLE_API int pfclose (PFile *stream)
PORTABLE_API void prewind (PFile *stream)
PORTABLE_API int pfseek (PFile *stream, long offset, int origin)
PORTABLE_API long pftell (PFile *stream)
PORTABLE_API LCHARpfgets (LCHAR *string, int n, PFile *stream)
PORTABLE_API int pfeof (PFile *stream)
PORTABLE_API int pferror (PFile *stream)
PORTABLE_API void pclearerr (PFile *stream)
PORTABLE_API LINT pfgetc (PFile *stream)
PORTABLE_API int pfflush (PFile *stream)
PORTABLE_API int pvfprintf (PFile *stream, const LCHAR *format, va_list args)
PORTABLE_API int pfprintf (PFile *stream, const LCHAR *format,...)
PORTABLE_API
ESR_ReturnCode 
pf_convert_backslashes_to_forwardslashes (LCHAR *string_to_convert)
PORTABLE_API
ESR_ReturnCode 
pf_is_path_absolute (const LCHAR *input_path, ESR_BOOL *isAbsolute)
PORTABLE_API
ESR_ReturnCode 
pf_make_dir (const LCHAR *path)
PORTABLE_API
ESR_ReturnCode 
pf_get_cwd (LCHAR *path, size_t *len)
PORTABLE_API
ESR_ReturnCode 
pf_change_dir (const LCHAR *path)


Define Documentation

#define PEOF   EOF

Portable EOF constant


Typedef Documentation

typedef FILE PFile

Portable file.


Function Documentation

PORTABLE_API void pclearerr ( PFile stream  ) 

Backwards compatible clearerr().

Parameters:
stream See clearerr()

PORTABLE_API ESR_ReturnCode pf_convert_backslashes_to_forwardslashes ( LCHAR string_to_convert  ) 

Backwards compatible printf().

Parameters:
format See printf()
Returns:
see printf()

PORTABLE_API int pfclose ( PFile stream  ) 

Backwards compatible fclose().

Parameters:
stream See fclose()
Returns:
see fclose()

PORTABLE_API int pfeof ( PFile stream  ) 

Backwards compatible feof().

Parameters:
stream See feof()
Returns:
see feof()

PORTABLE_API int pferror ( PFile stream  ) 

Backwards compatible ferror().

Parameters:
stream See ferror()
Returns:
see ferror()

PORTABLE_API int pfflush ( PFile stream  ) 

Backwards compatible fflush().

Parameters:
stream See fflush()
Returns:
see fflush()

PORTABLE_API LINT pfgetc ( PFile stream  ) 

Backwards compatible fgetc().

Parameters:
stream See clearerr()
Returns:
see clearerr()

PORTABLE_API LCHAR* pfgets ( LCHAR string,
int  n,
PFile stream 
)

Backwards compatible fgets().

Parameters:
string See fgets()
n See fgets()
stream See fgets()
Returns:
see fgets()

PORTABLE_API PFile* pfopen ( const LCHAR filename,
const LCHAR mode 
)

Backwards compatible fopen().

Parameters:
filename See fopen()
mode See fopen()
Returns:
see fopen()

PORTABLE_API int pfprintf ( PFile stream,
const LCHAR format,
  ... 
)

Backwards compatible fprintf().

Parameters:
stream See fprintf()
format See fprintf()
Returns:
see fprintf()

PORTABLE_API size_t pfread ( void *  buffer,
size_t  size,
size_t  count,
PFile stream 
)

Backwards compatible fread().

Parameters:
buffer See fread()
size See fread()
count See fread()
stream See fread()
Returns:
see fread()

PORTABLE_API int pfseek ( PFile stream,
long  offset,
int  origin 
)

Backwards compatible fseek().

Parameters:
stream See fseek()
offset See fseek()
origin See fseek()
Returns:
see fseek()

PORTABLE_API long pftell ( PFile stream  ) 

Backwards compatible ftell().

Parameters:
stream See ftell()
Returns:
see ftell()

PORTABLE_API size_t pfwrite ( void *  buffer,
size_t  size,
size_t  count,
PFile stream 
)

Backwards compatible fwrite().

Parameters:
buffer See fwrite()
size See fwrite()
count See fwrite()
stream See fwrite()
Returns:
see fwrite()

PORTABLE_API void prewind ( PFile stream  ) 

Backwards compatible rewind()

Parameters:
stream See rewind()
Returns:
see rewind()

PORTABLE_API int pvfprintf ( PFile stream,
const LCHAR format,
va_list  args 
)

Backwards compatible vfprintf().

Parameters:
stream See vfprintf()
format See vfprintf()
args See vfprintf()
Returns:
see vfprintf()


Generated on Thu May 1 15:37:26 2008 for SREC by  doxygen 1.5.3