beos.h File Reference

BeOS Support. More...

#include <wfio/type.h>
#include <wfio/device.h>

Go to the source code of this file.

Classes
class	wfio::os::beos::BeOSDevice
	A device wrapping a BeOS IO Object. More...

Namespaces
	wfio
	The root namespace for WFIO.
	wfio::os::beos
	Elements of WFIO related to BeOS.
	wfio::beos
	Elements of WFIO related to BeOS.

Functions
WFIO_C_BEGIN WFIO_CXX_DLL struct wfio_device_t *	wfio_beos_devFromDataIO (BDataIO *io, int *error)
	Open a new device by wrapping a BDataIO instance. More...
WFIO_CXX_DLL struct wfio_device_t *	wfio_beos_devFromPositionIO (BPositionIO *io, int *error)
	Open a new device by wrapping a BPositionIO instance. More...
WFIO_CXX_DLL struct wfio_device_t *	wfio_beos_devFromBufferIO (BBufferIO *io, int *error)
	Open a new device by wrapping a BBufferIO instance. More...
WFIO_CXX_DLL enum wfio_ecode_t	wfio_beos_errorFromNative (int ecode)
	Translate a BeOS error code into a WFIO error. More...
inline ::wfio_ecode_t	wfio::os::beos::errorFromNative (int error) throw ()
	Translate a BeOS error code into a WFIO error. More...

Detailed Description

BeOS Support.

In addition to the POSIX-like and stdio APIs, BeOS provides its own object-oriented API for manipulating I/O streams. This header contains wrapper functions and a subclass of wfio::Device to make interfacing instances of BDataIO with WFIO easier. This header generally contains code that can be used to interface with a BeOS system.

Author

Phillip Kilgore

Since

0.0.1

Note

This file includes type.h

Warning

This header requires libwfiox

This header cannot be included by systems that are not BeOS or Haiku.

Function Documentation

wfio_beos_devFromBufferIO()

WFIO_CXX_DLL struct wfio_device_t* wfio_beos_devFromBufferIO	(	BBufferIO *	io,
		int *	error
	)

Open a new device by wrapping a BBufferIO instance.

Parameters

io	The BBufferIO instance to open.
error	An optional error indicator.

Returns

A device wrapping the BufferIO object on success; otherwise, NULL.

wfio_beos_devFromDataIO()

WFIO_C_BEGIN WFIO_CXX_DLL struct wfio_device_t* wfio_beos_devFromDataIO	(	BDataIO *	io,
		int *	error
	)

Open a new device by wrapping a BDataIO instance.

Parameters

io	The BDataIO instance to open.
error	An optional error indicator.

Returns

A device wrapping the DataIO object on success; otherwise, NULL.

wfio_beos_devFromPositionIO()

WFIO_CXX_DLL struct wfio_device_t* wfio_beos_devFromPositionIO	(	BPositionIO *	io,
		int *	error
	)

Open a new device by wrapping a BPositionIO instance.

Parameters

io	The BPositionIO instance to open.
error	An optional error indicator.

Returns

A device wrapping the PositionIO object on success; otherwise, NULL.

wfio_beos_errorFromNative()

WFIO_CXX_DLL enum wfio_ecode_t wfio_beos_errorFromNative

(

int

ecode

)

Translate a BeOS error code into a WFIO error.

This function attempts to translate an error code into its WFIO counterpart. It can operate on either negative or positive error codes; if the error code is positive, then it is converted into its negative counterpart before translation occurs.

Parameters

ecode

The error code to translate.

Returns

The corresponding WFIO error code for this BeOS error code.