osapi_stdio.h File Reference

Standard I/O interface definition. More...

#include "osapi/osapi_dll.h"
#include "osapi/osapi_types.h"

Go to the source code of this file.

Functions
void	OSAPI_Stdio_puts (const char *string)
	Print string to standard output.
void	OSAPI_Stdio_printf (const char *format,...)
	Print formatted string to standard output.
RTI_INT32	OSAPI_Stdio_snprintf (char *buffer, RTI_SIZE_T n, const char *format,...)
	Print formatted string to the provided buffer.
RTI_INT32	OSAPI_Stdio_vsnprintf (char *s, RTI_SIZE_T n, const char *format, va_list ap)
	Print formatted string to the provided buffer.

---

Detailed Description

Standard I/O interface definition.

I/O utilities.

---

Function Documentation

void OSAPI_Stdio_puts

(

const char *

string

)

Print string to standard output.

Prints the ASCIIZ string to stdout.

Parameters:

[in]

string

- ASCIIZ string to print

Exceptions:

None.

void OSAPI_Stdio_printf	(	const char *	format,
			...
	)

Print formatted string to standard output.

Output a formatted string to standard output. Only the following modifiers are supported: s,c,h,d,u,x,X,p,l

Parameters:

[in]	format	- ASCIIZ format string to print
[in]	...	- Optional arguments to format string

Exceptions:

None.

RTI_INT32 OSAPI_Stdio_snprintf	(	char *	buffer,
		RTI_SIZE_T	n,
		const char *	format,
			...
	)

Print formatted string to the provided buffer.

Output a formatted string to standard output. Only the following modifiers are supported: s,c,h,d,u,x,X,p,l. The number of bytes that would have been written are returned. Thus, if a value >= n is returned buffer was too small to hold the formatted string.

Parameters:

[in]	buffer	- buffer to hold resulting string
[in]	n	- Maximum number of bytes in buffer
[in]	format	- ASCIIZ format string to print
[in]	...	- Optional arguments to format string

Exceptions:

None.

RTI_INT32 OSAPI_Stdio_vsnprintf	(	char *	s,
		RTI_SIZE_T	n,
		const char *	format,
		va_list	ap
	)

Print formatted string to the provided buffer.

Output a formatted string to standard output. Only the following modifiers are supported: s,c,h,d,u,x,X,p,l. The number of bytes that would have been written are returned. Thus, if a value >= n is returned buffer was too small to hold the formatted string.

Parameters:

[in]	s	- buffer to hold resulting string
[in]	n	- Maximum number of bytes in buffer
[in]	format	- ASCIIZ format string to print
[in]	ap	- Optional arguments to format string

Exceptions:

None.