writablefile.h File Reference

Writable file IO support. More...

#include "bitablecommon.h"

Go to the source code of this file.

Typedefs
typedef struct BitableWritableFile	BitableWritableFile

Functions
BITABLE_API BitableResult	bitable_wf_create (BitableWritableFile **file, const char *path)
BITABLE_API BitableResult	bitable_wf_seek (BitableWritableFile *file, int64_t position)
BITABLE_API BitableResult	bitable_wf_write (BitableWritableFile *file, const void *data, uint32_t size)
BITABLE_API BitableResult	bitable_wf_sync (BitableWritableFile *file)
BITABLE_API BitableResult	bitable_wf_close (BitableWritableFile *file)

Detailed Description

Writable file IO support.

Typedef Documentation

typedef struct BitableWritableFile BitableWritableFile

OS specific structure for the handle information for a writable file.

Function Documentation

BITABLE_API BitableResult bitable_wf_close

(

BitableWritableFile *

file

)

Close a previously opened file.

Parameters

file	The file to close. Does not null check.

Returns

A return code indicating either success, or the reason for failure.

BITABLE_API BitableResult bitable_wf_create	(	BitableWritableFile **	file,
		const char *	path
	)

Create a file for writing, allocating the handle information

Parameters

[out]	file	Allocated open file handling for writing - should be closed with bitable_wf_close if this open function is successful. No null check performed.
	path	The file path to open, should be in UTF8 encoding. Does not null check.

Returns

A return code indicating either success, or the reason for failure.

BITABLE_API BitableResult bitable_wf_seek	(	BitableWritableFile *	file,
		int64_t	position
	)

Seek to a position in a previously opened file relative the beginning.

Parameters

file	The file to seek in. Does not null check.
position	The position to seek to.

Returns

A return code indicating either success, or the reason for failure.

BITABLE_API BitableResult bitable_wf_sync

(

BitableWritableFile *

file

)

Sync a file to disk, including its metadata.

Parameters

file	The file to sync. Does not null check.

Returns

A return code indicating either success, or the reason for failure.

BITABLE_API BitableResult bitable_wf_write	(	BitableWritableFile *	file,
		const void *	data,
		uint32_t	size
	)

Write data to the current file point for a file.

Parameters

file	The file to write to. Does not null check.
data	The data to write. Does not null check.
size	The amount of data to write in bytes.

Returns

A return code indicating either success, or the reason for failure.