RTI Connext Micro  Version 2.4.1.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
osapi_stdio.h
Go to the documentation of this file.
1 /*
2  * FILE: osapi_stdio.h - Definition of semaphore interface
3  *
4  * Copyright 2012-2014 Real-Time Innovations, Inc.
5  *
6  * No duplications, whole or partial, manual or electronic, may be made
7  * without express written permission. Any such copies, or
8  * revisions thereof, must display this notice unaltered.
9  * This code contains trade secrets of Real-Time Innovations, Inc.
10  *
11  * Modification History
12  * --------------------
13  * 12mar2012,tk Written
14  */
15 /*e \file
16  * \brief Standard I/O interface definition
17  */
18 #ifndef osapi_stdio_h
19 #define osapi_stdio_h
20 
21 #ifndef osapi_dll_h
22 #include "osapi/osapi_dll.h"
23 #endif
24 
25 #if defined(__ANDROID__)
26 #include <android/log.h>
27 #endif
28 
29 #ifndef osapi_types_h
30 #include "osapi/osapi_types.h"
31 #endif
32 
33 #ifdef __cplusplus
34 extern "C"
35 {
36 #endif
37 
38 /*e \file
39  * \brief I/O utilities.
40  */
41 
42 /* \defgroup OSAPI_StdioClass OSAPI Standard I/O
43  * \ingroup OSAPIModule
44  *
45  * \brief OS-independent standard I/O utilities.
46  */
47 
48 /*e \ingroup OSAPI_StdioClass
49  * \brief Print string to standard output.
50  *
51  * \details
52  * Prints the ASCIIZ string to stdout.
53  *
54  * \param[in] string - ASCIIZ string to print
55  *
56  * @exception None.
57  */
58 OSAPIDllExport void
59 OSAPI_Stdio_puts(const char *string);
60 
61 /*e \ingroup OSAPI_StdioClass
62  * \brief Print formatted string to standard output.
63  *
64  * \details
65  * Output a formatted string to standard output. Only the following modifiers
66  * are supported: s,c,h,d,u,x,X,p,l
67  *
68  * \param[in] format - ASCIIZ format string to print
69  * \param[in] ... - Optional arguments to format string
70  *
71  * @exception None.
72  *
73  */
74 OSAPIDllExport void
75 OSAPI_Stdio_printf(const char *format,...);
76 
77 /*e \ingroup OSAPI_StdioClass
78  *
79  * \brief Print formatted string to the provided buffer
80  *
81  * \details
82  * Output a formatted string to standard output. Only the following modifiers
83  * are supported: s,c,h,d,u,x,X,p,l. The number of bytes that would have been
84  * written are returned. Thus, if a value >= n is returned buffer was too small
85  * to hold the formatted string.
86  *
87  * \param[in] buffer - buffer to hold resulting string
88  * \param[in] n - Maximum number of bytes in buffer
89  * \param[in] format - ASCIIZ format string to print
90  * \param[in] ... - Optional arguments to format string
91  *
92  * @exception None.
93  */
94 OSAPIDllExport RTI_INT32
95 OSAPI_Stdio_snprintf(char *buffer, RTI_SIZE_T n, const char *format,...);
96 
97 
98 /*e \ingroup OSAPI_StdioClass
99  *
100  * \brief Print formatted string to the provided buffer
101  *
102  * \details
103  * Output a formatted string to standard output. Only the following modifiers
104  * are supported: s,c,h,d,u,x,X,p,l. The number of bytes that would have been
105  * written are returned. Thus, if a value >= n is returned buffer was too small
106  * to hold the formatted string.
107  *
108  * \param[in] s - buffer to hold resulting string
109  * \param[in] n - Maximum number of bytes in buffer
110  * \param[in] format - ASCIIZ format string to print
111  * \param[in] ap - Optional arguments to format string
112  *
113  * @exception None.
114  */
115 OSAPIDllExport RTI_INT32
116 OSAPI_Stdio_vsnprintf(char *s, RTI_SIZE_T n, const char *format,va_list ap);
117 
118 #ifdef __cplusplus
119 }
120 #endif
121 
122 #endif /* osapi_stdio_h */
RTI Connext Micro Version 2.4.1.0 Copyright © Thu Nov 20 2014 Real-Time Innovations, Inc