# OS_NS_stdio.h File Reference

`#include "ace/config-all.h"`
`#include "ace/os_include/os_stdio.h"`
`#include "ace/os_include/os_fcntl.h"`
`#include "ace/ACE_export.h"`
`#include "ace/OS_NS_stdio.inl"`

Include dependency graph for OS_NS_stdio.h:

This graph shows which files directly or indirectly include this file:

## Namespaces

namespace | ACE_OS

## Classes

class | ACE_OS::ace_flock_t
| OS file locking structure. More...

## Wrappers to obtain the current user id

ACE_NAMESPACE_INLINE_FUNCTION char * | cuserid (char *user, size_t maxlen=ACE_MAX_USERID)
ACE_NAMESPACE_INLINE_FUNCTION wchar_t * | cuserid (wchar_t *user, size_t maxlen=ACE_MAX_USERID)

## A set of wrappers for file locks.

ACE_NAMESPACE_INLINE_FUNCTION void | flock_adjust_params (ace_flock_t *lock, short whence, off_t &start, off_t &len)
ACE_NAMESPACE_INLINE_FUNCTION int | flock_init (ace_flock_t *lock, int flags=0, const ACE_TCHAR *name=0, mode_t perms=0)
ACE_NAMESPACE_INLINE_FUNCTION int | flock_destroy (ace_flock_t *lock, int unlink_file=1)
ACE_NAMESPACE_INLINE_FUNCTION int | flock_rdlock (ace_flock_t *lock, short whence=0, off_t start=0, off_t len=0)
ACE_NAMESPACE_INLINE_FUNCTION int | flock_tryrdlock (ace_flock_t *lock, short whence=0, off_t start=0, off_t len=0)
ACE_NAMESPACE_INLINE_FUNCTION int | flock_trywrlock (ace_flock_t *lock, short whence=0, off_t start=0, off_t len=0)
ACE_NAMESPACE_INLINE_FUNCTION int | flock_unlock (ace_flock_t *lock, short whence=0, off_t start=0, off_t len=0)
ACE_NAMESPACE_INLINE_FUNCTION int | flock_wrlock (ace_flock_t *lock, short whence=0, off_t start=0, off_t len=0)

## Defines

#define | ACE_EXPORT_MACRO ACE_Export
#define | ACE_INLINE inline

## Functions

ACE_NAMESPACE_INLINE_FUNCTION void | clearerr (FILE *fp)
ACE_NAMESPACE_INLINE_FUNCTION int | fclose (FILE *fp)
ACE_NAMESPACE_INLINE_FUNCTION FILE * | fdopen (ACE_HANDLE handle, const ACE_TCHAR *mode)
ACE_NAMESPACE_INLINE_FUNCTION int | fflush (FILE *fp)
ACE_NAMESPACE_INLINE_FUNCTION int | fgetc (FILE *fp)
ACE_NAMESPACE_INLINE_FUNCTION int | fgetpos (FILE *fp, fpos_t *pos)
ACE_NAMESPACE_INLINE_FUNCTION char * | fgets (char *buf, int size, FILE *fp)
ACE_NAMESPACE_INLINE_FUNCTION wchar_t * | fgets (wchar_t *buf, int size, FILE *fp)
ACE_Export FILE * | fopen (const char *filename, const ACE_TCHAR *mode)
ACE_Export FILE * | fopen (const wchar_t *filename, const ACE_TCHAR *mode)
ACE_NAMESPACE_INLINE_FUNCTION LPSECURITY_ATTRIBUTES | default_win32_security_attributes (LPSECURITY_ATTRIBUTES)
| Default Win32 Security Attributes definition.
ACE_NAMESPACE_INLINE_FUNCTION LPSECURITY_ATTRIBUTES | default_win32_security_attributes_r (LPSECURITY_ATTRIBUTES, LPSECURITY_ATTRIBUTES, SECURITY_DESCRIPTOR *)
ACE_NAMESPACE_INLINE_FUNCTION const OSVERSIONINFO & | get_win32_versioninfo (void)
| Return the win32 OSVERSIONINFO structure.
ACE_NAMESPACE_INLINE_FUNCTION HINSTANCE | get_win32_resource_module (void)
ACE_NAMESPACE_INLINE_FUNCTION void | set_win32_resource_module (HINSTANCE)
ACE_NAMESPACE_INLINE_FUNCTION void | fopen_mode_to_open_mode_converter (ACE_TCHAR x, int &hmode)
ACE_Export int | fprintf (FILE *fp, const char *format,...)
ACE_Export int | fprintf (FILE *fp, const wchar_t *format,...)
ACE_NAMESPACE_INLINE_FUNCTION int | fputs (const char *s, FILE *stream)
ACE_NAMESPACE_INLINE_FUNCTION int | fputs (const wchar_t *s, FILE *stream)
ACE_NAMESPACE_INLINE_FUNCTION size_t | fread (void *ptr, size_t size, size_t nelems, FILE *fp)
ACE_NAMESPACE_INLINE_FUNCTION FILE * | freopen (const ACE_TCHAR *filename, const ACE_TCHAR *mode, FILE *stream)
ACE_NAMESPACE_INLINE_FUNCTION int | fseek (FILE *fp, long offset, int ptrname)
ACE_NAMESPACE_INLINE_FUNCTION int | fsetpos (FILE *fp, fpos_t *pos)
ACE_NAMESPACE_INLINE_FUNCTION long | ftell (FILE *fp)
ACE_NAMESPACE_INLINE_FUNCTION size_t | fwrite (const void *ptr, size_t size, size_t nitems, FILE *fp)
ACE_NAMESPACE_INLINE_FUNCTION void | perror (const char *s)
ACE_NAMESPACE_INLINE_FUNCTION void | perror (const wchar_t *s)
ACE_Export int | printf (const char *format,...)
ACE_NAMESPACE_INLINE_FUNCTION int | puts (const char *s)
ACE_NAMESPACE_INLINE_FUNCTION int | puts (const wchar_t *s)
ACE_NAMESPACE_INLINE_FUNCTION int | rename (const char *old_name, const char *new_name, int flags=-1)
ACE_NAMESPACE_INLINE_FUNCTION int | rename (const wchar_t *old_name, const wchar_t *new_name, int flags=-1)
ACE_NAMESPACE_INLINE_FUNCTION void | rewind (FILE *fp)
ACE_Export int | snprintf (char *buf, size_t maxlen, const char *format,...)
ACE_Export int | snprintf (wchar_t *buf, size_t maxlen, const wchar_t *format,...)
ACE_Export int | sprintf (char *buf, const char *format,...)
ACE_Export int | sprintf (wchar_t *buf, const wchar_t *format,...)
ACE_NAMESPACE_INLINE_FUNCTION char * | tempnam (const char *dir=0, const char *pfx=0)
ACE_NAMESPACE_INLINE_FUNCTION wchar_t * | tempnam (const wchar_t *dir, const wchar_t *pfx=0)
ACE_NAMESPACE_INLINE_FUNCTION int | vsprintf (char *buffer, const char *format, va_list argptr)
ACE_NAMESPACE_INLINE_FUNCTION int | vsnprintf (char *buffer, size_t maxlen, const char *format, va_list argptr)
ACE_NAMESPACE_INLINE_FUNCTION int | vsprintf (wchar_t *buffer, const wchar_t *format, va_list argptr)
ACE_NAMESPACE_INLINE_FUNCTION int | vsnprintf (wchar_t *buffer, size_t maxlen, const wchar_t *format, va_list argptr)

## Variables

ACE_Export OSVERSIONINFO | win32_versioninfo_
ACE_Export HINSTANCE | win32_resource_module_

## Detailed Description

Id
  OS_NS_stdio.h,v 1.19 2006/01/23 15:50:44 jwillemsen Exp

Author:
  Douglas C. Schmidt <schmidt@cs.wustl.edu>

  Jesper S. M|ller<stophph@diku.dk>

  and a cast of thousands...

Originally in OS.h.

## Define Documentation

#define ACE_EXPORT_MACRO ACE_Export

#define ACE_INLINE inline

## Function Documentation

ACE_INLINE void ACE_OS::clearerr | ( | FILE * | fp | ) |

ACE_INLINE wchar_t * ACE_OS::cuserid | ( | wchar_t * | user,
|  | size_t | maxlen = `ACE_MAX_USERID`
| ) |

ACE_INLINE char * ACE_OS::cuserid | ( | char * | user,
|  | size_t | maxlen = `ACE_MAX_USERID`
| ) |

ACE_NAMESPACE_INLINE_FUNCTION LPSECURITY_ATTRIBUTES default_win32_security_attributes | ( | LPSECURITY_ATTRIBUTES |  | ) |

| Default Win32 Security Attributes definition.

ACE_NAMESPACE_INLINE_FUNCTION LPSECURITY_ATTRIBUTES default_win32_security_attributes_r | ( | LPSECURITY_ATTRIBUTES | ,
|  | LPSECURITY_ATTRIBUTES | ,
|  | SECURITY_DESCRIPTOR * |
| ) |

ACE_INLINE int ACE_OS::fclose | ( | FILE * | fp | ) |

ACE_INLINE FILE * ACE_OS::fdopen | ( | ACE_HANDLE | handle,
|  | const ACE_TCHAR * | mode
| ) |

ACE_INLINE int ACE_OS::fflush | ( | FILE * | fp | ) |

ACE_INLINE int ACE_OS::fgetc | ( | FILE * | fp | ) |

ACE_INLINE int ACE_OS::fgetpos | ( | FILE * | fp,
|  | fpos_t * | pos
| ) |

ACE_INLINE wchar_t * ACE_OS::fgets | ( | wchar_t * | buf,
|  | int | size,
|  | FILE * | fp
| ) |

ACE_INLINE char * ACE_OS::fgets | ( | char * | buf,
|  | int | size,
|  | FILE * | fp
| ) |

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE void ACE_OS::flock_adjust_params | ( | ace_flock_t * | lock,
|  | short | whence,
|  | off_t & | start,
|  | off_t & | len
| ) |

ACE_INLINE int ACE_OS::flock_destroy | ( | ace_flock_t * | lock,
|  | int | unlink_file = `1`
| ) |

ACE_INLINE int ACE_OS::flock_init | ( | ace_flock_t * | lock,
|  | int | flags = `0`,
|  | const ACE_TCHAR * | name = `0`,
|  | mode_t | perms = `0`
| ) |

ACE_INLINE int ACE_OS::flock_rdlock | ( | ace_flock_t * | lock,
|  | short | whence = `0`,
|  | off_t | start = `0`,
|  | off_t | len = `0`
| ) |

ACE_INLINE int ACE_OS::flock_tryrdlock | ( | ace_flock_t * | lock,
|  | short | whence = `0`,
|  | off_t | start = `0`,
|  | off_t | len = `0`
| ) |

ACE_INLINE int ACE_OS::flock_trywrlock | ( | ace_flock_t * | lock,
|  | short | whence = `0`,
|  | off_t | start = `0`,
|  | off_t | len = `0`
| ) |

ACE_INLINE int ACE_OS::flock_unlock | ( | ace_flock_t * | lock,
|  | short | whence = `0`,
|  | off_t | start = `0`,
|  | off_t | len = `0`
| ) |

ACE_INLINE int ACE_OS::flock_wrlock | ( | ace_flock_t * | lock,
|  | short | whence = `0`,
|  | off_t | start = `0`,
|  | off_t | len = `0`
| ) |

FILE * ACE_OS::fopen | ( | const wchar_t * | filename,
|  | const ACE_TCHAR * | mode
| ) |

FILE * ACE_OS::fopen | ( | const char * | filename,
|  | const ACE_TCHAR * | mode
| ) |

ACE_INLINE void ACE_OS::fopen_mode_to_open_mode_converter | ( | ACE_TCHAR | x,
|  | int & | hmode
| ) |

| Translate fopen's mode char to open's mode. This helper function is here to avoid maintaining several pieces of identical code.

int ACE_OS::fprintf | ( | FILE * | fp,
|  | const wchar_t * | format,
|  |  | ...
| ) |

int ACE_OS::fprintf | ( | FILE * | fp,
|  | const char * | format,
|  |  | ...
| ) |

ACE_INLINE int ACE_OS::fputs | ( | const wchar_t * | s,
|  | FILE * | stream
| ) |

ACE_INLINE int ACE_OS::fputs | ( | const char * | s,
|  | FILE * | stream
| ) |

ACE_INLINE size_t ACE_OS::fread | ( | void * | ptr,
|  | size_t | size,
|  | size_t | nelems,
|  | FILE * | fp
| ) |

ACE_INLINE FILE * ACE_OS::freopen | ( | const ACE_TCHAR * | filename,
|  | const ACE_TCHAR * | mode,
|  | FILE * | stream
| ) |

ACE_INLINE int ACE_OS::fseek | ( | FILE * | fp,
|  | long | offset,
|  | int | ptrname
| ) |

ACE_INLINE int ACE_OS::fsetpos | ( | FILE * | fp,
|  | fpos_t * | pos
| ) |

ACE_INLINE long ACE_OS::ftell | ( | FILE * | fp | ) |

ACE_INLINE size_t ACE_OS::fwrite | ( | const void * | ptr,
|  | size_t | size,
|  | size_t | nitems,
|  | FILE * | fp
| ) |

ACE_NAMESPACE_INLINE_FUNCTION HINSTANCE get_win32_resource_module | ( | void |  | ) |

| Return the handle of the module containing ACE's resources. By default, for a DLL build of ACE this is a handle to the ACE DLL itself, and for a static build it is a handle to the executable.

ACE_NAMESPACE_INLINE_FUNCTION const OSVERSIONINFO& get_win32_versioninfo | ( | void |  | ) |

| Return the win32 OSVERSIONINFO structure.

ACE_INLINE void ACE_OS::perror | ( | const wchar_t * | s | ) |

ACE_INLINE void ACE_OS::perror | ( | const char * | s | ) |

int ACE_OS::printf | ( | const char * | format,
|  |  | ...
| ) |

ACE_INLINE int ACE_OS::puts | ( | const wchar_t * | s | ) |

ACE_INLINE int ACE_OS::puts | ( | const char * | s | ) |

ACE_INLINE int ACE_OS::rename | ( | const wchar_t * | old_name,
|  | const wchar_t * | new_name,
|  | int | flags = `-1`
| ) |

ACE_INLINE int ACE_OS::rename | ( | const char * | old_name,
|  | const char * | new_name,
|  | int | flags = `-1`
| ) |

ACE_INLINE void ACE_OS::rewind | ( | FILE * | fp | ) |

ACE_NAMESPACE_INLINE_FUNCTION void set_win32_resource_module | ( | HINSTANCE |  | ) |

| Allow an application to modify which module contains ACE's resources. This is mainly useful for a static build of ACE where the required resources reside somewhere other than the executable.

int ACE_OS::snprintf | ( | wchar_t * | buf,
|  | size_t | maxlen,
|  | const wchar_t * | format,
|  |  | ...
| ) |

int ACE_OS::snprintf | ( | char * | buf,
|  | size_t | maxlen,
|  | const char * | format,
|  |  | ...
| ) |

int ACE_OS::sprintf | ( | wchar_t * | buf,
|  | const wchar_t * | format,
|  |  | ...
| ) |

int ACE_OS::sprintf | ( | char * | buf,
|  | const char * | format,
|  |  | ...
| ) |

ACE_INLINE wchar_t * ACE_OS::tempnam | ( | const wchar_t * | dir,
|  | const wchar_t * | pfx = `0`
| ) |

ACE_INLINE char * ACE_OS::tempnam | ( | const char * | dir = `0`,
|  | const char * | pfx = `0`
| ) |

ACE_INLINE int ACE_OS::vsnprintf | ( | wchar_t * | buffer,
|  | size_t | maxlen,
|  | const wchar_t * | format,
|  | va_list | argptr
| ) |

ACE_INLINE int ACE_OS::vsnprintf | ( | char * | buffer,
|  | size_t | maxlen,
|  | const char * | format,
|  | va_list | argptr
| ) |

ACE_INLINE int ACE_OS::vsprintf | ( | wchar_t * | buffer,
|  | const wchar_t * | format,
|  | va_list | argptr
| ) |

ACE_INLINE int ACE_OS::vsprintf | ( | char * | buffer,
|  | const char * | format,
|  | va_list | argptr
| ) |

## Variable Documentation

HINSTANCE ACE_OS::win32_resource_module_

ACE_BEGIN_VERSIONED_NAMESPACE_DECL OSVERSIONINFO ACE_OS::win32_versioninfo_