Document return values
[ACE_TAO.git] / ACE / ace / OS_NS_sys_shm.h
blob5ad517b49e9c309eda395846a5699262c0e02d4b
1 // -*- C++ -*-
3 //=============================================================================
4 /**
5 * @file OS_NS_sys_shm.h
7 * @author Douglas C. Schmidt <d.schmidt@vanderbilt.edu>
8 * @author Jesper S. M|ller<stophph@diku.dk>
9 * @author and a cast of thousands...
11 //=============================================================================
13 #ifndef ACE_OS_NS_SYS_SHM_H
14 # define ACE_OS_NS_SYS_SHM_H
16 # include /**/ "ace/pre.h"
18 # include "ace/config-all.h"
20 # if !defined (ACE_LACKS_PRAGMA_ONCE)
21 # pragma once
22 # endif /* ACE_LACKS_PRAGMA_ONCE */
24 #include "ace/os_include/sys/os_shm.h"
25 #include /**/ "ace/ACE_export.h"
27 #if defined (ACE_EXPORT_MACRO)
28 # undef ACE_EXPORT_MACRO
29 #endif
30 #define ACE_EXPORT_MACRO ACE_Export
32 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
34 namespace ACE_OS
36 //@{ @name A set of wrappers for System V shared memory.
37 ACE_NAMESPACE_INLINE_FUNCTION
38 void *shmat (int int_id,
39 const void *shmaddr,
40 int shmflg);
42 ACE_NAMESPACE_INLINE_FUNCTION
43 int shmctl (int int_id,
44 int cmd,
45 struct shmid_ds *buf);
47 ACE_NAMESPACE_INLINE_FUNCTION
48 int shmdt (const void *shmaddr);
50 ACE_NAMESPACE_INLINE_FUNCTION
51 int shmget (key_t key,
52 size_t size,
53 int flags);
54 //@}
55 } /* namespace ACE_OS */
57 ACE_END_VERSIONED_NAMESPACE_DECL
59 # if defined (ACE_HAS_INLINED_OSCALLS)
60 # if defined (ACE_INLINE)
61 # undef ACE_INLINE
62 # endif /* ACE_INLINE */
63 # define ACE_INLINE inline
64 # include "ace/OS_NS_sys_shm.inl"
65 # endif /* ACE_HAS_INLINED_OSCALLS */
67 # include /**/ "ace/post.h"
68 #endif /* ACE_OS_NS_SYS_SHM_H */